From 99ceea07beb3d8718ff62fdf45fb704e1988ac58 Mon Sep 17 00:00:00 2001 From: Nikita Pekin Date: Wed, 22 Jun 2016 10:51:07 -0400 Subject: [PATCH] docs(README): update `README.md` --- README.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 70 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9134e8a..989126b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,71 @@ # wolfram-alpha-rs -Rust bindings for the WolframAlpha API + + + + + + + + + +
Linux / OS Xtravis-badge
+ api-docs-badge + crates-io + license-badge + coveralls-badge +
+ +Rust bindings for the Wolfram|Alpha API. + +# Table of Contents + +* [Usage](#usage) +* [Contributing](#contributing) +* [Credits](#credits) +* [License](#license) + +## Usage + +Add the following to your `Cargo.toml`: + +```toml +[dependencies] +wolfram_alpha = "0.1" +``` + +And in your `lib.rs` or `main.rs`: + +```rust +extern crate wolfram_alpha; +``` + +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 + +wolfram-alpha-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/wolfram-alpha-rs/wolfram_alpha +[contributing]: https://github.com/indiv0/wolfram-alpha-rs/blob/master/CONTRIBUTING.md "Contribution Guide" +[contributors]: https://github.com/indiv0/wolfram-alpha-rs/blob/master/CONTRIBUTORS.md "List of Contributors" +[license-apache]: https://github.com/indiv0/wolfram-alpha-rs/blob/master/LICENSE-APACHE "Apache-2.0 License" +[license-mit]: https://github.com/indiv0/wolfram-alpha-rs/blob/master/LICENSE-MIT "MIT License"