Java development kit for prismic.io

Getting started

Install the kit for your project through Maven

This library is on Maven Central. The kit coordinates are:

<dependency>
  <groupId>io.prismic</groupId>
  <artifactId>java-kit</artifactId>
  <version>X.X.X</version>
</dependency>

(you may need to adapt the version number)

The kit requires Java 8 or superior.

Documentation

• Prismic.io documentation
• Javadoc

Changelog

Need to see what changed, or to upgrade your kit? We keep our changelog on this repository's "Releases" tab.

Install the kit locally

Run ./mvnw install.

Always run ./mvnw test before committing, to make sure everything runs as expected.

Test

Please write tests using JUnit4 for any bugfix or new feature; please add the tests to the AppTest.java file. Run ./mvnw test to test.

If you find existing code that is not optimally tested and wish to make it better, we really appreciate it; but you should document it on its own branch and its own pull request.

Documenting

Please document any bugfix or new feature using the Javadoc syntax

If you find existing code that is not optimally documented and wish to make it better, we really appreciate it; but you should document it on its own branch and its own pull request.

Publish Javadoc

(Only for Prismic.io developers)

./mvnw clean javadoc:javadoc scm-publish:publish-scm

Licence

This software is licensed under the Apache 2 license, quoted below.

Copyright 2018 Prismic.io (https://prismic.io).

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.