Skip to content

Commit

Permalink
Adapted README
Browse files Browse the repository at this point in the history
  • Loading branch information
Stefan Deser committed Dec 12, 2023
1 parent bc14a3b commit 67a69f1
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# easytable

This is a small project that builds upon
[Apache's PDFBox](http://pdfbox.apache.org) and should allow you
[Apache's PDFBox](http://pdfbox.apache.org) (>= 3.0.0) and should allow you
to create tables in a fairly simple way.
It emerged from the need in another project. Therefore, it also may miss some
crucial features. Nevertheless, there is:
Expand Down Expand Up @@ -33,7 +33,7 @@ Add this to your `pom.xml`:
<dependency>
<groupId>com.github.vandeseer</groupId>
<artifactId>easytable</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>1.0.1-SNAPSHOT</version>
</dependency>

Or checkout the repository and install it locally with maven (e.g. for the`develop` branch):
Expand All @@ -43,7 +43,7 @@ Or checkout the repository and install it locally with maven (e.g. for the`devel
## Examples

There is a [minimal full working example](src/test/java/org/vandeseer/MinimumWorkingExample.java)
which should help you getting started.
which should help you to get started.

For a bit more involved tables have a look at [this code](src/test/java/org/vandeseer/integrationtest/ExcelLikeExampleTest.java)
which is needed for creating a PDF document with the following two tables:
Expand Down Expand Up @@ -86,6 +86,18 @@ improvements

## Q&A

### Can I use the library with version PDFBox 2.x.x?

Every version of easytable < 1.0.0 is built on PDFBox 2.x.x.

Note that easytable 1.0.0 and below
do basically only differ in the support PDFBox version, but
not in their feature set. Only exception being the experimental support
for paragraph cells which had to be dropped with the upgrade to PDFBox 3.

Also note that easytable >= 1.0.0 is built for Java 11 and higher, whereas
lower versions are using Java 8.

### Can I customize the drawers for my own specific needs?

Yep, you can customize the cell drawers itself or (depending on your use case)
Expand Down

0 comments on commit 67a69f1

Please sign in to comment.