Create README.md

README.md

@@ -0,0 +1,68 @@
+# .Net library and tool to work with PDF files
+
+## Usage
+
+### VAR.PdfTools
+Add the resulting assembly as reference in your projects, and this line on code:
+
+	using VAR.PdfTools;
+
+Then extract the contents of a data column using:
+
+    var columnData = new List<string>();
+    PdfDocument doc = PdfDocument.Load("document.pdf");
+    foreach (PdfDocumentPage page in doc.Pages)
+    {
+        PdfTextExtractor extractor = new PdfTextExtractor(page);
+        columnData.AddRange(extractor.GetColumn("Column"));
+    }
+    
+Or the content of a field (text on the right of the indicated text):
+
+    var fieldData = new List<string>();
+    PdfDocument doc = PdfDocument.Load("document.pdf");
+    foreach (PdfDocumentPage page in doc.Pages)
+    {
+        PdfTextExtractor extractor = new PdfTextExtractor(page);
+        fieldData.Add(extractor.GetField(txtFieldName.Text));
+    }
+
+### VAR.PdfTools.Workbench
+It is a simple Windows.Forms application, to test basic funcitionallity of the library.
+
+## Building
+A Visual Studio 2015 and 2010 solutions are provided. Simply, click build on the IDE.
+
+## Contributing
+1. Fork it!
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin my-new-feature`
+5. Submit a pull request :D
+
+## Credits
+* Valeriano Alfonso Rodriguez.
+
+## License
+
+    The MIT License (MIT)
+
+    Copyright (c) 2014-2015 Valeriano Alfonso Rodriguez
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE.