Skip to content

Commit 0e0f3c7

Browse files
committed
finish #147 by adding info about verifying maven central jars using gpg; do #253 by adding maven and gradle examples; do #254 by adding what's new section
1 parent 76eb2ef commit 0e0f3c7

File tree

1 file changed

+49
-8
lines changed

1 file changed

+49
-8
lines changed

README.md

Lines changed: 49 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,25 +14,46 @@ The Java API supports the following core features of the MarkLogic database:
1414
* Execute ACID modifications so the change either succeeds or throws an exception.
1515
* Execute multi-statement transactions so changes to multiple documents succeed or fail together.
1616

17+
### What's New in Java Client API 3.0.1
18+
19+
* Pojo Façade - persist POJOs as JSON objects and use a simple API to query them with all the power
20+
of MarkLogic's search engine
21+
* Eval (and Invoke) - directly access MarkLogic's powerful server-side XQuery or JavaScript
22+
* Bulk Read & Write - send and retrieve documents and metadata in batches for significant performance
23+
improvements
24+
* JSON - JacksonHandle, JacksonDatabindHandle, and JacksonParserHandle make wrangling JSON a pleasure
25+
* JavaScript Extensions - develop production-ready server-side extensions using ready-to-go scaffolding
26+
27+
For more details, please read this [deeper dive](http://developer.marklogic.com/features/java-client-api-2)
28+
1729
### QuickStart
1830

19-
For people working with MarkLogic 8 EA
31+
To use the API in your maven project, include the following in your pom.xml:
2032

21-
$ mvn test-compile
22-
$ sh src/test/resources/boot-test.sh
23-
$ mvn test
33+
<dependency>
34+
<groupId>com.marklogic</groupId>
35+
<artifactId>java-client-api</artifactId>
36+
<version>3.0.1</version>
37+
</dependency>
38+
39+
For gradle projects, include the following:
40+
41+
dependencies {
42+
compile group: 'com.marklogic', name: 'java-client-api', version: '3.0.1'
43+
}
44+
45+
Read [The Java API in Five Minutes](http://developer.marklogic.com/try/java/index)
2446

2547
### Learning More
2648

27-
The following resources introduce and document the Java API:
49+
The following resources document the Java API:
2850

29-
* [The Java API in Five Minutes](http://developer.marklogic.com/try/java/index)
3051
* [Java Application Developer's Guide](http://docs.marklogic.com/guide/java)
3152
* [JavaDoc](http://docs.marklogic.com/javadoc/client/index.html)
3253

3354
### Installing
3455

35-
To use the Java API, either add a Maven dependency or download the jar and its dependencies:
56+
To use the Java API, either add Maven or Gradle dependency as explained above or download the jar and its dependencies:
3657

3758
http://developer.marklogic.com/products/java
3859

@@ -41,7 +62,19 @@ the developer license:
4162

4263
https://developer.marklogic.com/free-developer
4364

44-
### Building
65+
To obtain verified downloads signed with MarkLogic's PGP key, use maven tools or directly download
66+
the .jar and .asc files from
67+
[maven central](http://repo1.maven.org/maven2/com/marklogic/java-client-api/3.0.1/). MarkLogic's
68+
pgp key ID is 48D4B86E and it is available from pgp.mit.edu by installing gnupg and running the command:
69+
70+
$ gpg --keyserver pgp.mit.edu --recv-key 48D4B86E
71+
72+
Files can be verified with the command:
73+
74+
$ gpg java-client-api-3.0.1.jar.asc
75+
76+
77+
### Building and Contributing
4578

4679
You can build the API in the same way as any Maven project on git:
4780

@@ -52,5 +85,13 @@ You might want to skip the tests until you have configured a test database and R
5285

5386
$ mvn package -Dmaven.test.skip=true
5487

88+
See [Contributing.md](Contributing.md) for more on contributing to this github project.
89+
90+
### Running JUnit Tests
91+
92+
$ mvn test-compile
93+
$ sh src/test/resources/boot-test.sh
94+
$ mvn test
95+
5596
## Support
5697
The MarkLogic Java Client API is maintained by MarkLogic Engineering and distributed under the [Apache 2.0 license](https://github.com/marklogic/java-client-api/blob/master/LICENSE). It is designed for use in production applications with MarkLogic Server. Everyone is encouraged to file bug reports, feature requests, and pull requests through GitHub. This input is critical and will be carefully considered, but we can’t promise a specific resolution or timeframe for any request. In addition, MarkLogic provides technical support for [release tags](https://github.com/marklogic/java-client-api/releases) of the Java Client API to licensed customers under the terms outlined in the [Support Handbook](http://www.marklogic.com/files/Mark_Logic_Support_Handbook.pdf). For more information or to sign up for support, visit [help.marklogic.com](http://help.marklogic.com).

0 commit comments

Comments
 (0)