diff options
author | Paul Woolcock <paul@woolcock.us> | 2018-08-23 10:37:10 -0400 |
---|---|---|
committer | Paul Woolcock <paul@woolcock.us> | 2018-08-23 10:59:23 -0400 |
commit | ab82cf9124ef0b02bbfd2df1b43933bc48727aec (patch) | |
tree | 9e831a9ff2e9750738aee7a7992d9d4b76c7bcfe /README.md | |
parent | d710f4ab492ab46ebd6da6893d08bf615b618e84 (diff) |
Add `Installation` and `Usage` section to README
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 21 |
1 files changed, 20 insertions, 1 deletions
@@ -5,10 +5,29 @@ [![Docs](https://docs.rs/elefren/badge.svg)](https://docs.rs/elefren) [![MIT/APACHE-2.0](https://img.shields.io/crates/l/elefren.svg)](https://crates.io/crates/elefren) -## [Documentation](https://docs.rs/elefren/) +[Documentation](https://docs.rs/elefren/) A wrapper around the [API](https://github.com/tootsuite/documentation/blob/master/docs/Using-the-API/API.md#tag) for [Mastodon](https://mastodon.social/) +## Installation + +To add `elefren` to your project, add the following to the +`[dependencies]` section of your `Cargo.toml` + +```toml +elefren = { git = "https://github.com/pwoolcoc/elefren" } +``` + +## Usage + +To use this crate in your project, add this to your crate root (lib.rs, main.rs, etc): + +```rust +extern crate elefren; +``` + +## Example + ```rust extern crate elefren; extern crate toml; |