-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
70 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,71 @@ | ||
# wolfram-alpha-rs | ||
Rust bindings for the WolframAlpha API | ||
|
||
<table> | ||
<tr> | ||
<td><strong>Linux / OS X</strong></td> | ||
<td><a href="https://travis-ci.org/indiv0/wolfram-alpha-rs" title="Travis Build Status"><img src="https://travis-ci.org/indiv0/wolfram-alpha-rs.svg?branch=master" alt="travis-badge"></img></a></td> | ||
</tr> | ||
<tr> | ||
<td colspan="2"> | ||
<a href="https://indiv0.github.io/wolfram-alpha-rs/wolfram_alpha" title="API Docs"><img src="https://img.shields.io/badge/API-docs-blue.svg" alt="api-docs-badge"></img></a> | ||
<a href="https://crates.io/crates/wolfram_alpha" title="Crates.io"><img src="https://img.shields.io/crates/v/wolfram_alpha.svg" alt="crates-io"></img></a> | ||
<a href="#License" title="License: MIT/Apache-2.0"><img src="https://img.shields.io/crates/l/wolfram_alpha.svg" alt="license-badge"></img></a> | ||
<a href="https://coveralls.io/github/indiv0/wolfram-alpha-rs?branch=master" title="Coverage Status"><img src="https://coveralls.io/repos/github/indiv0/wolfram-alpha-rs/badge.svg?branch=master" alt="coveralls-badge"></img></a> | ||
</td> | ||
</tr> | ||
</table> | ||
|
||
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" |