Zynh0722/Riven
1
0
Fork 0
forked from mirror/Riven
Code Pull requests Activity

Update readme for stable, fix dep build issue, increment version

Browse source
This commit is contained in:
Mingwei Samuel 2019-11-07 12:56:59 -08:00
parent 9dfe5a4aaa
commit 69f7de55f3
3 changed files with 16 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.travis.yml
View file

@ -1,3 +1,4 @@
language: rust language: rust
rust: rust:
- stable
- nightly - nightly

6
Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "riven" name = "riven"
version = "0.1.0" version = "0.1.1"
authors = ["Mingwei Samuel <mingwei.samuel@gmail.com>"] authors = ["Mingwei Samuel <mingwei.samuel@gmail.com>"]
repository = "https://github.com/MingweiSamuel/Riven" repository = "https://github.com/MingweiSamuel/Riven"
description = "Riot Games API Library" description = "Riot Games API Library"
@ -8,6 +8,8 @@ readme = "README.md"
license = "MIT" license = "MIT"
edition = "2018" edition = "2018"
include = [ "src/**", "/README.md" ] include = [ "src/**", "/README.md" ]
keywords = [ "riot-games", "riot", "league", "league-of-legends" ]
categories = [ "api-bindings", "web-programming::http-client" ]
[badges] [badges]
travis-ci = { repository = "MingweiSamuel/Riven" } travis-ci = { repository = "MingweiSamuel/Riven" }
@ -29,6 +31,8 @@ strum = "0.16"
strum_macros = "0.16" strum_macros = "0.16"
tokio = { version = "0.2.0-alpha.6", default-features = false, features = [ "timer" ] } tokio = { version = "0.2.0-alpha.6", default-features = false, features = [ "timer" ] }
url = "2.1" url = "2.1"
# TODO temp pin.
async-compression = { version = "=0.1.0-alpha.7", default-features = false, features = ["gzip", "stream"], optional = true }
[dev-dependencies] [dev-dependencies]
colored = "1.8" colored = "1.8"

16
README.md
View file

@ -13,9 +13,7 @@ Rivens's goals are _speed_, _reliability_, and _maintainability_. Riven handles
Data structs and endpoints are automatically generated from the 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/)). [Riot API Reference](https://developer.riotgames.com/api-methods/) ([Swagger](http://www.mingweisamuel.com/riotapi-schema/tool/)).
Riven currently uses nightly Rust. ## Design
## Features
* Fast, asynchronous, thread-safe. * Fast, asynchronous, thread-safe.
* Automatically retries failed requests. * Automatically retries failed requests.
@ -74,11 +72,17 @@ Output:
10) Vladimir 37176 (5) 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/). [On docs.rs](https://docs.rs/riven/).
## Error Handling ### Error Handling
Riven returns `Result<Option<T>>` within futures. If the `Result` is errored, Riven returns `Result<Option<T>>` within futures. If the `Result` is errored,
this indicates that the API request failed to complete successfully, which may be 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 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. 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) Feel free to [make an issue](https://github.com/MingweiSamuel/Riven/issues/new)
if you are have any questions or trouble using Riven. if you are have any questions or trouble using Riven.