mirror/Riven
1
0
Fork 1
mirror of https://github.com/MingweiSamuel/Riven.git synced 2024-12-27 03:16:33 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: small updates to README.md

Browse source
This commit is contained in:
Mingwei Samuel 2024-03-04 14:40:17 -08:00
parent 4e74fefaae
commit 136ecc3c05
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -18,8 +18,9 @@ Data structs and endpoints are automatically generated from the
# Design # Design
* Fast, asynchronous, thread-safe. * Fast, asynchronous, thread-safe.
* Automatically retries failed requests. * Automatically retries failed requests, configurable.
* Supports all endpoints, kept up-to-date using [riotapi-schema](https://github.com/MingweiSamuel/riotapi-schema). * Supports all endpoints, kept up-to-date using [riotapi-schema](https://github.com/MingweiSamuel/riotapi-schema).
* Can compile to Wasm for server-side or browser+proxy use.
# Usage # Usage
@ -96,7 +97,10 @@ and specifying the `rustls-tls` feature:
riven = { version = "...", default-features = false, features = [ "rustls-tls" ] } riven = { version = "...", default-features = false, features = [ "rustls-tls" ] }
``` ```
Riven is additionally able to produce [tracing](https://docs.rs/tracing) spans for requests if the `tracing` feature is enabled. This feature is disabled by default. ### `log` or `tracing`
Riven is additionally able to produce [tracing](https://docs.rs/tracing) spans for requests if the `tracing` feature is enabled.
By default the `tracing` feature is disabled and Riven instead writes to [`log`](https://docs.rs/log).
## Docs ## Docs