|
1 |
| -# EXPERIMENTAL Rust Bindings For Couchbase Lite |
| 1 | +# Rust Bindings For Couchbase Lite |
2 | 2 |
|
3 |
| -This is a Rust API binding of [Couchbase Lite][CBL], an embedded NoSQL document database engine with sync. |
| 3 | +This is a Rust API of [Couchbase Lite][CBL], an embedded NoSQL document database engine with sync. |
4 | 4 |
|
5 | 5 | ## Disclaimer
|
6 | 6 |
|
7 |
| -> This library is **NOT SUPPORTED BY COUCHBASE**. Even if you are a Couchbase customer, our otherwise awesome support team cannot help you with using this library. |
8 |
| -
|
9 |
| -As of September 2021, this library is still incomplete and has been tested only partially and informally, mostly on one platform (macOS). Also the author is a novice Rustacean and may not be doing things the Rust Way. |
10 |
| - |
11 |
| -That said, we would like to maintain and improve this library as time permits. We welcome bug reports, fixes and improvements! |
| 7 | +This library is **NOT SUPPORTED BY COUCHBASE**, it was forked from Couchbase Labs' repo [couchbase-lite-rust][CBL_RUST] and finalized. |
| 8 | +It is currently used and maintained by Doctolib. |
| 9 | +The supported platforms are Windows, macOS, Linux, Android and iOS. |
12 | 10 |
|
13 | 11 | ## Building
|
14 | 12 |
|
15 |
| -**_"Some assembly required..."_** |
16 |
| - |
17 | 13 | ### 1. Install LLVM/Clang
|
18 | 14 |
|
19 | 15 | In addition to [Rust][RUST], you'll need to install LLVM and Clang, which are required by the
|
@@ -95,6 +91,7 @@ compatible bindings. For those APIs you can check out the document "[Using Fleec
|
95 | 91 | [RUST]: https://www.rust-lang.org
|
96 | 92 | [CBL]: https://www.couchbase.com/products/lite
|
97 | 93 | [CBL_C]: https://github.com/couchbase/couchbase-lite-C
|
| 94 | +[CBL_RUST]: https://github.com/couchbaselabs/couchbase-lite-rust |
98 | 95 | [CBLDOCS]: https://docs.couchbase.com/couchbase-lite/current/introduction.html
|
99 | 96 | [FLEECE]: https://github.com/couchbaselabs/fleece/wiki/Using-Fleece
|
100 | 97 | [BINDGEN]: https://rust-lang.github.io/rust-bindgen/
|
|
0 commit comments