|
1 | | -# <img src="https://raw.githubusercontent.com/glacials/splits-io/dec549110968c5a02df87cddff49a43549cceb92/public/logo.png" alt="splits.io" height="42" width="42" align="top"/> splits-io-api |
| 1 | +# 💔 splits-io-api Has Been Discontinued |
2 | 2 |
|
3 | | -[](https://github.com/LiveSplit/splits-io-api/actions) |
4 | | -[](https://crates.io/crates/splits-io-api) |
5 | | -[](https://docs.rs/splits-io-api/) |
6 | | -[](https://deps.rs/repo/github/LiveSplit/splits-io-api) |
7 | | - |
8 | | -Bindings to the splits.io API for Rust. Both native platforms and the web are |
9 | | -supported. |
10 | | - |
11 | | -## Example Usage |
12 | | - |
13 | | -```rust |
14 | | -// Create a splits.io API client. |
15 | | -let client = Client::new(); |
16 | | - |
17 | | -// Search for a runner. |
18 | | -let runner = Runner::search(&client, "cryze") |
19 | | - .await? |
20 | | - .into_iter() |
21 | | - .next() |
22 | | - .context("There is no runner with that name")?; |
23 | | - |
24 | | -assert_eq!(&*runner.name, "cryze92"); |
25 | | - |
26 | | -// Get the PBs for the runner. |
27 | | -let first_pb = runner.pbs(&client) |
28 | | - .await? |
29 | | - .into_iter() |
30 | | - .next() |
31 | | - .context("This runner doesn't have any PBs")?; |
32 | | - |
33 | | -// Get the game for the PB. |
34 | | -let game = first_pb.game.context("There is no game for the PB")?; |
35 | | - |
36 | | -assert_eq!(&*game.name, "The Legend of Zelda: The Wind Waker"); |
37 | | - |
38 | | -// Get the categories for the game. |
39 | | -let categories = game.categories(&client).await?; |
40 | | - |
41 | | -// Get the runs for the Any% category. |
42 | | -let runs = categories |
43 | | - .iter() |
44 | | - .find(|category| &*category.name == "Any%") |
45 | | - .context("Couldn't find category")? |
46 | | - .runs(&client) |
47 | | - .await?; |
48 | | - |
49 | | -assert!(!runs.is_empty()); |
50 | | -``` |
51 | | - |
52 | | -## License |
53 | | - |
54 | | -Licensed under either of |
55 | | - |
56 | | -* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) |
57 | | -* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) at your option. |
58 | | - |
59 | | -### Contribution |
60 | | - |
61 | | -Unless you explicitly state otherwise, any contribution intentionally submitted |
62 | | -for inclusion in the work by you shall be dual licensed as above, without any |
63 | | -additional terms or conditions. |
| 3 | +This repository provided API bindings for splits.io, a service that is no longer available. |
| 4 | +Read more here: [Ben Carlsson's Goodbye to Splits.io](https://twos.dev/splitsio.html) |
0 commit comments