Skip to content

Commit

Permalink
Update README.md (#190)
Browse files Browse the repository at this point in the history
Indicate JDK version that's used in release and Maven version that's used in build.
  • Loading branch information
ksclarke authored Nov 2, 2023
1 parent 1415022 commit 002bad5
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@

Jiiify Presentation is a [IIIF Presentation](http://iiif.io/api/presentation) library for Java. It does not contain a server. It's just for working with IIIF presentation manifests.

If you are interested in using the library with Python or Ruby (using Jython or JRuby) you'll want the [uber jar](https://repo1.maven.org/maven2/info/freelibrary/jiiify-presentation-v3/0.10.0/jiiify-presentation-v3-0.10.0-uber.jar) that's available from Maven Central. To assist with getting started, there are a few simple Ruby and Python examples in the [tests](https://github.com/ksclarke/jiiify-presentation/tree/v3/src/test) directory. They can also be found in the newly started [Jiiify Presentation GitBook](https://ksclarke.gitbook.io/jiiify-presentation/).

*Warning:* The API for v3 is still in active development. There will definitely be breaking changes before the library reaches version 1.0.0. After it reaches 1.0.0 and becomes stable, the project will use semantic versioning to indicate the types of changes associated with new releases.

### Prerequisites

* JDK >= 17 (this is the JDK that the released version uses)
* Maven >= 3.8.7 (this is what's used for building the project)

### Getting Started

A very simple Java example of using jiiify-presentation follows:
Expand Down

0 comments on commit 002bad5

Please sign in to comment.