From 69f7de55f3a99a60fefbbc0ef24b44f4715785c8 Mon Sep 17 00:00:00 2001 From: Mingwei Samuel Date: Thu, 7 Nov 2019 12:56:59 -0800 Subject: [PATCH] Update readme for stable, fix dep build issue, increment version --- .travis.yml | 1 + Cargo.toml | 6 +++++- README.md | 16 ++++++++++------ 3 files changed, 16 insertions(+), 7 deletions(-) diff --git a/.travis.yml b/.travis.yml index 2524f65..8653ff9 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,3 +1,4 @@ language: rust rust: + - stable - nightly diff --git a/Cargo.toml b/Cargo.toml index 69eea51..32c275a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "riven" -version = "0.1.0" +version = "0.1.1" authors = ["Mingwei Samuel "] repository = "https://github.com/MingweiSamuel/Riven" description = "Riot Games API Library" @@ -8,6 +8,8 @@ readme = "README.md" license = "MIT" edition = "2018" include = [ "src/**", "/README.md" ] +keywords = [ "riot-games", "riot", "league", "league-of-legends" ] +categories = [ "api-bindings", "web-programming::http-client" ] [badges] travis-ci = { repository = "MingweiSamuel/Riven" } @@ -29,6 +31,8 @@ strum = "0.16" strum_macros = "0.16" tokio = { version = "0.2.0-alpha.6", default-features = false, features = [ "timer" ] } url = "2.1" +# TODO temp pin. +async-compression = { version = "=0.1.0-alpha.7", default-features = false, features = ["gzip", "stream"], optional = true } [dev-dependencies] colored = "1.8" diff --git a/README.md b/README.md index 4fc6a31..0330d9d 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,7 @@ Rivens's goals are _speed_, _reliability_, and _maintainability_. Riven handles Data structs and endpoints are automatically generated from the [Riot API Reference](https://developer.riotgames.com/api-methods/) ([Swagger](http://www.mingweisamuel.com/riotapi-schema/tool/)). -Riven currently uses nightly Rust. - -## Features +## Design * Fast, asynchronous, thread-safe. * Automatically retries failed requests. @@ -74,11 +72,17 @@ Output: 10) Vladimir 37176 (5) ``` -## Docs +### Nightly vs Stable + +Enable the `nightly` feature to use nightly-only functionality. Mainly enables +[nightly optimizations in the `parking_lot` crate](https://github.com/Amanieu/parking_lot#nightly-vs-stable). +Also required for running async integration tests. + +### Docs [On docs.rs](https://docs.rs/riven/). -## Error Handling +### Error Handling Riven returns `Result>` within futures. If the `Result` is errored, this indicates that the API request failed to complete successfully, which may be @@ -86,7 +90,7 @@ due to bad user input, Riot server errors, incorrect API key, etc. If the `Optio is `None`, this indicates that the request completed successfully but no data was returned. This happens if a summoner (by name) or match (by id) doesn't exist. -## Additional Info +### Additional Info Feel free to [make an issue](https://github.com/MingweiSamuel/Riven/issues/new) if you are have any questions or trouble using Riven.