Skip to content

Commit 3438b24

Browse files
committed
README touchup
1 parent 8a7fa8a commit 3438b24

File tree

1 file changed

+29
-17
lines changed

1 file changed

+29
-17
lines changed

README.md

Lines changed: 29 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,7 @@ from node.js.
55

66
## Status
77

8-
This branch provides the work in progress for the Early Access Release 3 of the MarkLogic node.js API.
9-
10-
### Checked in for EA3
11-
12-
* quick path for simple JavaScript object CRUD and query
13-
* values and tuples requests
14-
* server-side transforms on query response summary and result documents in slice() clause
15-
* snippets including custom snippets in slice() clause
16-
* projection from result documents (extract)
17-
* resource service CRUD and invocation for XQuery
18-
* graph CRUD and SPARQL query
19-
* specifying the database when creating a database client
20-
* search suggest
21-
* server-side eval
8+
This branch provides the work in progress for the Early Access Release 3 of the MarkLogic node.js API.
229

2310
## Getting started
2411

@@ -69,6 +56,20 @@ To tear down the test database and REST server, execute
6956

7057
node etc/test-teardown.js
7158

59+
### Capabilities added to the node.js Client API in Early Access 3
60+
61+
* quick path for simple CRUD and query on the database client
62+
* values and tuples requests
63+
* server-side transforms on query response summary and result documents in slice() clause
64+
* snippets including custom snippets in slice() clause
65+
* extract from result documents (projection)
66+
* resource service CRUD and invocation
67+
* graph CRUD and SPARQL query
68+
* bitemporal document CRUD and query
69+
* specifying the database when creating a database client
70+
* server-side eval and invoke
71+
* search suggest
72+
7273
### Capabilities of the node.js Client API in Early Access 2
7374

7475
* createDatabaseClient() including HTTPS
@@ -106,10 +107,21 @@ To tear down the test database and REST server, execute
106107
* config.extlibs.write()
107108
* optimistic locking
108109

109-
### Limitations in Early Access 2
110+
### Limitations in Early Access 3
110111

111112
The MarkLogic node.js Client API has not yet undergone performance or
112-
stress testing. The API should not be used in production in EA2.
113+
stress testing. The API should not be used in production in EA3. The
114+
interface may change before the initial release.
113115

114116
## Support
115-
The MarkLogic Node.js Client API is maintained by MarkLogic Engineering. 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/node-client-api/releases) of the Node 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](help.marklogic.com).
117+
118+
The MarkLogic Node.js Client API is maintained by MarkLogic Engineering.
119+
It is designed for use in production applications with MarkLogic Server.
120+
Everyone is encouraged to file bug reports, feature requests, and pull
121+
requests through GitHub. This input is critical and will be carefully
122+
considered, but we can’t promise a specific resolution or timeframe for
123+
any request. In addition, MarkLogic provides technical support
124+
for [release tags](https://github.com/marklogic/node-client-api/releases)
125+
of the Node Client API to licensed customers under the terms outlined
126+
in the [Support Handbook](http://www.marklogic.com/files/Mark_Logic_Support_Handbook.pdf).
127+
For more information or to sign up for support, visit [help.marklogic.com](help.marklogic.com).

0 commit comments

Comments
 (0)