Skip to content

Commit

Permalink
chore: updated readme docs section
Browse files Browse the repository at this point in the history
  • Loading branch information
NikitaMasych committed Oct 18, 2024
1 parent 31c5231 commit a77cfab
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,16 @@
## Documentation

Library is documented with `rustdoc`.
Compiled documentation for `main` branch is available at [GitBook](https://distributed-lab.github.io/bpcon).
Compiled production documentation for `main` branch is available at https://docs.rs/bpcon.
For other branches, development documentation is published to [GitBook](https://distributed-lab.github.io/bpcon/).

## Usage

### Add dependency in your `Cargo.toml`

```toml
[dependencies]
bpcon = {version = "0.1.0", git = "https://github.com/distributed-lab/bpcon"}
bpcon = "0.1.0"
```

### Implement [Value](https://distributed-lab.github.io/bpcon/bpcon/value/trait.Value.html) trait
Expand Down

0 comments on commit a77cfab

Please sign in to comment.