diff --git a/README.md b/README.md index c77b49f..8d39ce0 100644 --- a/README.md +++ b/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). \ No newline at end of file diff --git a/TODO b/TODO index 81248e0..1d89731 100644 --- a/TODO +++ b/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 diff --git a/common-api/pom.xml b/common-api/pom.xml index 19499f8..ea0ffe4 100644 --- a/common-api/pom.xml +++ b/common-api/pom.xml @@ -34,7 +34,7 @@ https://xpdf.io - GNU General Public License (GPL) version 3 + GNU General Public License, version 3 (GPLv3) https://www.gnu.org/licenses/gpl-3.0.html diff --git a/pdf-text-api-spring-boot-starter/pom.xml b/pdf-text-api-spring-boot-starter/pom.xml index 4ef282a..d95d0a0 100644 --- a/pdf-text-api-spring-boot-starter/pom.xml +++ b/pdf-text-api-spring-boot-starter/pom.xml @@ -34,7 +34,7 @@ https://xpdf.io - GNU General Public License (GPL) version 3 + GNU General Public License, version 3 (GPLv3) https://www.gnu.org/licenses/gpl-3.0.html diff --git a/pdf-text-api/pom.xml b/pdf-text-api/pom.xml index 58ab5bb..5041609 100644 --- a/pdf-text-api/pom.xml +++ b/pdf-text-api/pom.xml @@ -34,7 +34,7 @@ https://xpdf.io - GNU General Public License (GPL) version 3 + GNU General Public License, version 3 (GPLv3) https://www.gnu.org/licenses/gpl-3.0.html diff --git a/pom.xml b/pom.xml index 6dfd1a2..e1d3613 100644 --- a/pom.xml +++ b/pom.xml @@ -31,7 +31,7 @@ https://xpdf.io - GNU General Public License (GPL) version 3 + GNU General Public License, version 3 (GPLv3) https://www.gnu.org/licenses/gpl-3.0.html