Skip to content

Commit 5e5e6df

Browse files
committed
README cleanup
1 parent 4cfc383 commit 5e5e6df

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ They are present in the directory `libcblite`.
3535

3636
The different releases can be found in [this page][CBL_DOWNLOAD_PAGE].
3737

38-
Running the following script will download and setup the libraries locally:
38+
When a new C release is available, a new Rust release must be created. Running the following script will download and setup the libraries locally:
3939

4040
```shell
4141
$ ./update_cblite_c.sh -v 3.2.1
4242
```
4343

44-
If the command fails on MacOS when downloading the packages, you might need to install wget or a recent bash version:
44+
If the script fails on MacOS, you might need to install wget or a recent bash version:
4545

4646
```shell
4747
$ brew install wget
@@ -50,7 +50,7 @@ $ brew install bash
5050

5151
After that, fix the compilation & tests and you can create a pull request.
5252

53-
New features should also be added to the Rust API at some point.
53+
New C features should also be added to the Rust API at some point.
5454

5555
### Test
5656

@@ -80,9 +80,7 @@ $ LSAN_OPTIONS=suppressions=san.supp RUSTFLAGS="-Zsanitizer=address" cargo +nigh
8080

8181
[C API reference][CBL_API_REFERENCE]
8282

83-
The Rust API is mostly method-for-method compatible with the languages documented there, except
84-
down at the document property level (dictionaries, arrays, etc.) where I haven't yet written
85-
compatible bindings. For those APIs you can check out the document "[Using Fleece][FLEECE]".
83+
[Using Fleece][FLEECE]
8684

8785
[RUST]: https://www.rust-lang.org
8886

0 commit comments

Comments
 (0)