starts readme

README.md

@@ -1,2 +1,26 @@
-# xpdf-api
+# Xpdf API
 
+Xpdf API is a collection of Java APIs for [Xpdf](https://www.xpdfreader.com/about.html), an open source library for working with PDF files written in C++.
+Xpdf is an invaluable PDF toolkit, which this project aims to make more accessible to the Java community.
+
+Our primary goals are:
+* Provide full programmatic access to Xpdf.
+* Act as a pure, unobscured interface to Xpdf.
+
+APIs are available for the following Xpdf functions:
+* _pdftotext_ - extract text from PDF files
+
+## Getting Started
+
+An API is available for each of the individual 
+### Dependency
+
+TODO: maven pdf-text-api link
+
+TODO: maven pdf-text-api-starter link
+
+### PdfTextTool
+
+## License
+
+Xpdf API is Open Source software released under the [GNU General Public License, version 3 (GPLv3)](https://www.gnu.org/licenses/gpl-3.0.html).

TODO

@@ -1,6 +1,8 @@
 - licensing
   - understand difference between license, copyright, and trademark, and what that means for this project https://stackoverflow.com/a/13437203/8784215
     do i have to reference original Glyph/Cog copyright or anything?
+- package structure - the release package is sooo small in size.
+  is there any reason NOT to group the modules together into a single module??
 - write README
 - make github repo public
 - setup namecheap xpdf.io domain to automatically redirect to github repo, until website built

common-api/pom.xml

@@ -34,7 +34,7 @@
     <url>https://xpdf.io</url>
     <licenses>
         <license>
-            <name>GNU General Public License (GPL) version 3</name>
+            <name>GNU General Public License, version 3 (GPLv3)</name>
             <url>https://www.gnu.org/licenses/gpl-3.0.html</url>
         </license>
     </licenses>

pdf-text-api-spring-boot-starter/pom.xml

@@ -34,7 +34,7 @@
     <url>https://xpdf.io</url>
     <licenses>
         <license>
-            <name>GNU General Public License (GPL) version 3</name>
+            <name>GNU General Public License, version 3 (GPLv3)</name>
             <url>https://www.gnu.org/licenses/gpl-3.0.html</url>
         </license>
     </licenses>

pdf-text-api/pom.xml

@@ -34,7 +34,7 @@
     <url>https://xpdf.io</url>
     <licenses>
         <license>
-            <name>GNU General Public License (GPL) version 3</name>
+            <name>GNU General Public License, version 3 (GPLv3)</name>
             <url>https://www.gnu.org/licenses/gpl-3.0.html</url>
         </license>
     </licenses>

pom.xml

@@ -31,7 +31,7 @@
     <url>https://xpdf.io</url>
     <licenses>
         <license>
-            <name>GNU General Public License (GPL) version 3</name>
+            <name>GNU General Public License, version 3 (GPLv3)</name>
             <url>https://www.gnu.org/licenses/gpl-3.0.html</url>
         </license>
     </licenses>