From 136ecc3c0588eac437eb93e2e876fe42d48a7631 Mon Sep 17 00:00:00 2001 From: Mingwei Samuel Date: Mon, 4 Mar 2024 14:40:17 -0800 Subject: [PATCH] docs: small updates to README.md --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f22d3ad..8968dd9 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,9 @@ Data structs and endpoints are automatically generated from the # Design * 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). +* Can compile to Wasm for server-side or browser+proxy use. # Usage @@ -96,7 +97,10 @@ and specifying the `rustls-tls` feature: 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