Install the kit for your project through Maven
You can find this library in our own Maven repository (hosted on Github).
<repository>
<id>prismicio</id>
<name>prismic.io Repository</name>
<url>https://github.com/prismicio/repository/raw/master/maven/</url>
</repository>
The kit coordinates are:
<dependency>
<groupId>io.prismic</groupId>
<artifactId>java-kit</artifactId>
<version>1.0-M5</version>
</dependency>
(you may need to adapt the version number)
You can find out how to get started with prismic.io on our prismic.io developer's portal.
Also on our prismic.io developer's portal, on top of our full documentation, you will:
- get a thorough introduction of how to use prismic.io kits, including this one.
- see what else is available for Java: starter projects, examples, ...
You can find the documentation on this Javadoc.
Through Java's syntax, this kit contains some mild differences and syntastic sugar over the section of our documentation that tells you how to use prismic.io kits in general (which you should read first). The differences are listed here:
- Traditional POJO getter-and-setter syntaxes are applied; therefore, one calls a SearchForm like this:
api.getForm("everything")
Need to see what changed, or to upgrade your kit? We keep our changelog on this repository's "Releases" tab.
Contribution is open to all developer levels, read our "Contribute to the official kits" documentation to learn more.
You will need Maven to contribute to the kit; first install it if you haven't.
Then run mvn compile.
Always run mvn test before committing, to make sure everything runs as expected.
Please write tests using JUnit3 for any bugfix or new feature; please add the tests to the AppTest.java file. Run mvn 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.
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.
This software is licensed under the Apache 2 license, quoted below.
Copyright 2013 Zengularity (http://www.zengularity.com).
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.