An open API service indexing awesome lists of open source software.

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

Awesome Lists containing this project

README

          

# xkcd-rs


Linux
travis-badge



api-docs-badge
crates-io
license-badge
coveralls-badge

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"