Skip to content

indiv0/xkcd-rs

Repository files navigation

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

Add the following to your Cargo.toml:

[dependencies]
xkcd = "0.3"

And in your lib.rs or main.rs:

extern crate xkcd;

See the 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 before you start contributing.

Credits

The higher-level API design for this library is inspired by the slack-rs/slack-rs-api library.

The list of contributors to this project can be found at CONTRIBUTORS.md.

License

xkcd-rs is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE, and LICENSE-MIT for details.