Add Installation and Usage section to README
This commit is contained in:
@@ -5,10 +5,29 @@
|
|||||||
[](https://docs.rs/elefren)
|
[](https://docs.rs/elefren)
|
||||||
[](https://crates.io/crates/elefren)
|
[](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/)
|
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
|
```rust
|
||||||
extern crate elefren;
|
extern crate elefren;
|
||||||
extern crate toml;
|
extern crate toml;
|
||||||
|
|||||||
Reference in New Issue
Block a user