Skip to content

Commit c2347b3

Browse files
committed
Prepare readme for GA
1 parent 8ab52c6 commit c2347b3

2 files changed

Lines changed: 19 additions & 17 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This driver is an overlay over the [ScyllaDB Rust Driver](https://github.com/scy
88
with the interface based on the [Node.js Driver for Apache Cassandra](https://github.com/apache/cassandra-nodejs-driver) (formerly known as DataStax Node.js Driver).
99
Although optimized for ScyllaDB, the driver is also compatible with [Apache Cassandra®](https://cassandra.apache.org/).
1010

11-
This driver is currently in the experimental state. We are working on features necessary for the driver to be considered production ready.
11+
This driver is considered production ready. Some optional driver features are still missing and will be added in the following releases.
1212

1313
## Getting started
1414

@@ -20,7 +20,7 @@ Currently only linux x86_64 architecture is supported with planned support for o
2020

2121
### Documentation
2222

23-
The API ([documentation](https://nodejs-rs-driver.docs.scylladb.com/stable/api/)) of the driver is based on the Cassandra driver.
23+
The [documentation](https://nodejs-rs-driver.docs.scylladb.com/stable/api/) of the driver is based on the Cassandra Node.js and ScyllaDB Rust drivers.
2424
Some of the endpoints are already implemented, others are planned, and some parts of the API (including features that were deprecated and are specific to DataStax databases) are removed.
2525
The status of each API endpoint is listed in [this document](https://docs.google.com/spreadsheets/d/e/2PACX-1vRR8BUXy5u_DLNMet4L2MEmjSE0eeOX2SQIq8Sxy5BI8OoLeOopWlD2I_6-IWcas-rKw06o19la5-q6/pubhtml?gid=2021765806) and unimplemented features are tracked in the repository [issues](https://github.com/scylladb/nodejs-rs-driver/issues).
2626

@@ -35,6 +35,7 @@ You can find example usages of the driver in the [examples directory](https://gi
3535

3636
The driver supports the following:
3737

38+
- Migration guide from the DataStax driver
3839
- Simple, Prepared, and Batch statements
3940
- Asynchronous IO, parallel execution, request pipelining
4041
- Token-aware routing
@@ -45,17 +46,16 @@ The driver supports the following:
4546
- Row streaming and pipes
4647
- Built-in TypeScript support
4748
- Password authentication
48-
- Configurable load balancing policies
49+
- Configurable load balancing, retry policies
50+
- Simple address translation policy
4951
- Error handling, based on the Rust driver
5052
- SSL support
53+
- Driver logging
54+
- Faster performance, compared to DataStax Node.js driver(*)
5155

52-
Features that are planned for the driver to become production ready:
53-
54-
- Configurable retry policies
55-
- Faster performance, compared to DataStax Node.js driver
56-
- Migration guide from the DataStax driver
56+
(*) In most of the internally conducted benchmarks
5757

58-
For other planned features see our [Milestones](https://github.com/scylladb/nodejs-rs-driver/milestones)
58+
For planned features see our [Milestones](https://github.com/scylladb/nodejs-rs-driver/milestones)
5959

6060
## Reference Documentation
6161

docs/source/index.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Although optimized for ScyllaDB, the driver is also compatible with `Apache Cass
99

1010
.. caution::
1111

12-
This driver is currently in the experimental state.
13-
We are working on features necessary for the driver to be considered production ready.
12+
This driver is considered production ready.
13+
Some optional driver features are still missing and will be added in the following releases.
1414

1515
.. toctree::
1616
:maxdepth: 2
@@ -48,6 +48,7 @@ Features
4848

4949
The driver supports the following:
5050

51+
- Migration guide from the DataStax driver
5152
- Simple, Prepared, and Batch statements
5253
- Asynchronous IO, parallel execution, request pipelining
5354
- Token-aware routing
@@ -59,17 +60,18 @@ The driver supports the following:
5960
- Built-in TypeScript support
6061
- Password authentication
6162
- SSL support
63+
- Configurable load balancing, retry policies
64+
- Simple address translation policy
6265
- Error handling, based on the Rust driver
66+
- Driver logging
67+
- Faster performance, compared to DataStax Node.js driver(*)
68+
69+
(*) In most of the internally conducted benchmarks
6370

6471
Roadmap
6572
-------
6673

67-
Features planned for the driver to become production ready:
68-
69-
- Configurable load balancing and retry policies
70-
- Faster performance, compared to Apache cassandra-driver
71-
72-
For other planned features, see the `Milestones <https://github.com/scylladb/nodejs-rs-driver/milestones>`_.
74+
For planned features, see the `Milestones <https://github.com/scylladb/nodejs-rs-driver/milestones>`_.
7375

7476
Other resources
7577
===============

0 commit comments

Comments
 (0)