Skip to content

Commit 23714d7

Browse files
committed
readme: update dependency and doc
Signed-off-by: ekexium <[email protected]>
1 parent fa43464 commit 23714d7

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,12 @@ The TiKV client is a Rust library (crate). To use this crate in your project, ad
2020
```toml
2121
[dependencies]
2222
tikv-client = { git = "https://github.com/tikv/client-rust.git" }
23-
24-
[patch.crates-io]
25-
raft-proto = { git = "https://github.com/tikv/raft-rs", rev = "e624c1d48460940a40d8aa69b5329460d9af87dd" }
2623
```
2724

2825
The client requires a Git dependency until we can [publish it](https://github.com/tikv/client-rust/issues/32).
2926

3027
The client provides two modes to interact with TiKV: raw and transactional.
31-
In the current version (0.0.0), the transactional API only supports optimistic transactions.
28+
In the current version (0.0.0), the transactional API supports optimistic transactions. Pessimistic transactions are implemented but not well tested.
3229

3330
Important note: It is **not recommended or supported** to use both the raw and transactional APIs on the same database.
3431

@@ -111,10 +108,11 @@ To use the client, there are 4 types you will need.
111108

112109
## Access the documentation
113110

114-
We recommend using the cargo-generated documentation to browse and understand the API. We've done
115-
our best to include ample, tested, and understandable examples.
111+
We've done our best to include ample, tested, and understandable examples.
112+
113+
We recommend using the officially maintained documentation [here](https://www.tikv.dev/doc/rust-client/tikv_client/).
116114

117-
You can access the documentation on your machine by running the following in any project that depends on `tikv-client`.
115+
You can also access the documentation on your machine by running the following in any project that depends on `tikv-client`.
118116

119117
```bash
120118
cargo doc --package tikv-client --open

0 commit comments

Comments
 (0)