Skip to content

Commit 0e0ab40

Browse files
authored
Merge pull request #1626 from marklogic/feature/readme-update
Simplified README
2 parents 5f4f7a8 + 90eebf6 commit 0e0ab40

File tree

1 file changed

+27
-58
lines changed

1 file changed

+27
-58
lines changed

README.md

Lines changed: 27 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,14 @@
33
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
44
[![Known Vulnerabilities](https://snyk.io/test/github/marklogic/java-client-api/badge.svg)](https://snyk.io/test/github/marklogic/java-client-api)
55

6-
# The MarkLogic Java Client API
6+
# The MarkLogic Java Client
77

8-
The API makes it easy to write, read, delete, and find documents
9-
in a [MarkLogic](http://developer.marklogic.com/) database.
8+
The MarkLogic Java Client makes it easy to write, read, delete, and find documents
9+
in a [MarkLogic](http://developer.marklogic.com/) database. The client requires connecting to a
10+
[MarkLogic REST API app server](https://docs.marklogic.com/guide/rest-dev) and is ideal for applications wishing to
11+
build upon the MarkLogic REST API.
1012

11-
For example:
12-
13-
// write a text, binary, XML, or JSON document from any source with ACID guarantees
14-
documentManager.write(uri, new FileHandle()
15-
.with(new File("file1234.json"))
16-
.withFormat(JSON));
17-
18-
// read and directly parse to your preferred type, even your own POJOs!
19-
JsonNode jsonDocContents = documentManager.readAs(uri, JsonNode.class);
20-
21-
// get matches super-fast using full-featured search
22-
JsonNode results = queryManager.search(
23-
new StructuredQueryBuilder().term("quick", "brown", "fox"),
24-
new JacksonHandle()).get();
25-
26-
The Java API supports the following core features of the MarkLogic database:
13+
The client supports the following core features of the MarkLogic database:
2714

2815
* Write and read binary, JSON, text, and XML documents.
2916
* Query data structure trees, marked-up text, and all the hybrids in between those extremes.
@@ -35,32 +22,37 @@ The Java API supports the following core features of the MarkLogic database:
3522
* Call Data Services by means of a Java interface on the client for data functionality
3623
implemented by an endpoint on the server.
3724

38-
The Java API can be used in applications running on Java 8, 11, and 17. If you are using Java 11 or higher and intend
25+
The client can be used in applications running on Java 8, 11, and 17. If you are using Java 11 or higher and intend
3926
to use [JAXB](https://docs.oracle.com/javase/tutorial/jaxb/intro/), please see the section below for ensuring that the
4027
necessary dependencies are available in your application's classpath.
4128

4229
## QuickStart
4330

44-
To use the API in your [Maven](https://maven.apache.org/) project, include the following in your pom.xml file:
31+
To use the client in your [Maven](https://maven.apache.org/) project, include the following in your `pom.xml` file:
4532

4633
<dependency>
4734
<groupId>com.marklogic</groupId>
4835
<artifactId>marklogic-client-api</artifactId>
49-
<version>6.2.2</version>
36+
<version>6.4.1</version>
5037
</dependency>
5138

52-
To use the API in your [Gradle](https://gradle.org/) project, include the following in your build.gradle file:
39+
To use the client in your [Gradle](https://gradle.org/) project, include the following in your `build.gradle` file:
5340

5441
dependencies {
55-
implementation "com.marklogic:marklogic-client-api:6.2.2"
42+
implementation "com.marklogic:marklogic-client-api:6.4.1"
5643
}
5744

5845
Next, read [The Java API in Five Minutes](http://developer.marklogic.com/try/java/index) to get started.
5946

60-
### Including JAXB support
47+
Full documentation is available at:
48+
49+
* [Java Application Developer's Guide](http://docs.marklogic.com/guide/java)
50+
* [JavaDoc](http://docs.marklogic.com/javadoc/client/index.html)
51+
52+
## Including JAXB support
6153

6254
If you are using Java 11 or higher (including Java 17) and you wish to use [JAXB](https://docs.oracle.com/javase/tutorial/jaxb/intro/)
63-
with the Java Client, you'll need to include JAXB API and implementation dependencies as those are no
55+
with the client, you'll need to include JAXB API and implementation dependencies as those are no
6456
longer included in Java 11 and higher.
6557

6658
For Maven, include the following in your pom.xml file:
@@ -111,39 +103,16 @@ JAXB 3.0 or JAXB 4.0 - for example:
111103
implementation "com.sun.xml.bind:jaxb-impl:4.0.1"
112104
}
113105

114-
The Java Client will soon be updated to use the newer `jakarta.xml.bind` interfaces. Until then, the above approach
106+
The client will soon be updated to use the newer `jakarta.xml.bind` interfaces. Until then, the above approach
115107
or one similar to it will allow for both the old and new JAXB interfaces and implementations to exist together in the
116108
same classpath.
117109

118-
### Learning More
119-
120-
The following resources document the Java API:
121-
122-
* [Java Application Developer's Guide](http://docs.marklogic.com/guide/java)
123-
* [JavaDoc](http://docs.marklogic.com/javadoc/client/index.html)
124-
125-
### Installing
126-
127-
To use the Java API, either add Maven or Gradle dependency as explained above or download the jar and its dependencies:
128-
129-
http://developer.marklogic.com/products/java
130-
131-
Of course, you'll also need to install the database -- which you can do for free with
132-
the developer license:
133-
134-
https://developer.marklogic.com/free-developer
135-
136-
To obtain verified downloads signed with MarkLogic's PGP key, use maven tools or directly download
137-
the .jar and .asc files from
138-
[maven central](https://repo1.maven.org/maven2/com/marklogic/marklogic-client-api/). MarkLogic's
139-
pgp key ID is 48D4B86E and it is available from pgp.mit.edu by installing gnupg and running the command:
140-
141-
$ gpg --keyserver pgp.mit.edu --recv-key 48D4B86E
142-
143-
Files can be verified with the command:
144-
145-
$ gpg marklogic-client-api-5.3.0.jar.asc
146-
147-
148110
## Support
149-
The MarkLogic Java Client API is maintained by [MarkLogic](https://www.marklogic.com/) Engineering and is made available 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](https://github.com/marklogic/java-client-api/issues). This input is critical and will be carefully considered. However, 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 [MarkLogic Technical Support Handbook](http://www.marklogic.com/files/Mark_Logic_Support_Handbook.pdf). Customers with an active maintenance contract can sign up for MarkLogic Technical Support on our [support portal](https://help.marklogic.com/).
111+
112+
The MarkLogic Java Client is maintained by [MarkLogic](https://www.marklogic.com/) Engineering and is made available under
113+
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.
114+
Everyone is encouraged to file bug reports, feature requests, and pull requests through [GitHub](https://github.com/marklogic/java-client-api/issues).
115+
This input is critical and will be carefully considered. However, we can’t promise a specific resolution or timeframe
116+
for any request. In addition, MarkLogic provides technical support for [release tags](https://github.com/marklogic/java-client-api/releases) of the Java Client to
117+
licensed customers under the terms outlined in the [MarkLogic Technical Support Handbook](http://www.marklogic.com/files/Mark_Logic_Support_Handbook.pdf). Customers with an
118+
active maintenance contract can sign up for MarkLogic Technical Support on our [support portal](https://help.marklogic.com/).

0 commit comments

Comments
 (0)