https://github.com/indiv0/xkcd-rs
Rust bindings for the XKCD web API
https://github.com/indiv0/xkcd-rs
rust rust-bindings xkcd xkcd-api
Last synced: about 1 year ago
JSON representation
Rust bindings for the XKCD web API
- Host: GitHub
- URL: https://github.com/indiv0/xkcd-rs
- Owner: indiv0
- License: apache-2.0
- Created: 2016-06-22T20:59:52.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-11-23T21:42:24.000Z (over 8 years ago)
- Last Synced: 2024-08-10T07:36:08.250Z (almost 2 years ago)
- Topics: rust, rust-bindings, xkcd, xkcd-api
- Language: Rust
- Homepage: https://indiv0.github.io/xkcd-rs/xkcd
- Size: 9.5 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# xkcd-rs
Rust bindings for the XKCD web API.
# Table of Contents
* [Usage](#usage)
* [Contributing](#contributing)
* [Credits](#credits)
* [License](#license)
## Usage
Add the following to your `Cargo.toml`:
```toml
[dependencies]
xkcd = "0.3"
```
And in your `lib.rs` or `main.rs`:
```rust
extern crate xkcd;
```
See the [API docs][api-docs] for information on using the crate in your library.
## Contributing
Contributions are always welcome!
If you have an idea for something to add (code, documentation, tests, examples,
etc.) feel free to give it a shot.
Please read [CONTRIBUTING.md][contributing] before you start contributing.
## Credits
The higher-level API design for this library is inspired by the
[slack-rs/slack-rs-api](https://github.com/slack-rs/slack-rs-api) library.
The list of contributors to this project can be found at
[CONTRIBUTORS.md][contributors].
## License
xkcd-rs is distributed under the terms of both the MIT license and the
Apache License (Version 2.0).
See [LICENSE-APACHE][license-apache], and [LICENSE-MIT][license-mit] for details.
[api-docs]: https://indiv0.github.io/xkcd-rs/xkcd
[contributing]: https://github.com/indiv0/xkcd-rs/blob/master/CONTRIBUTING.md "Contribution Guide"
[contributors]: https://github.com/indiv0/xkcd-rs/blob/master/CONTRIBUTORS.md "List of Contributors"
[license-apache]: https://github.com/indiv0/xkcd-rs/blob/master/LICENSE-APACHE "Apache-2.0 License"
[license-mit]: https://github.com/indiv0/xkcd-rs/blob/master/LICENSE-MIT "MIT License"