Updated README

master
Aaron Power 7 years ago
parent a6450f3445
commit f14363956f
  1. 45
      README.md

@ -1,34 +1,35 @@
# Mammut. A API Wrapper for the Mastodon API. # Mammut. A API Wrapper for the Mastodon API.
### [Documentation](https://docs.rs/mammut/) ## [Documentation](https://docs.rs/mammut/)
A wrapper around the [API](https://github.com/tootsuite/mastodon/blob/master/docs/Using-the-API/API.md#tag) for [Mastodon](https://mastodon.social/) A wrapper around the [API](https://github.com/tootsuite/mastodon/blob/master/docs/Using-the-API/API.md#tag) for [Mastodon](https://mastodon.social/)
```rust ```rust
# extern crate mammut; extern crate mammut;
# fn main() {
# try().unwrap();
# }
# fn try() -> mammut::Result<()> {
use mammut::Registration; use mammut::Registration;
use mammut::apps::{AppBuilder, Scope}; use mammut::apps::{AppBuilder, Scope};
let app = AppBuilder { fn main() {
client_name: "mammut_test", run().unwrap();
redirect_uris: "urn:ietf:wg:oauth:2.0:oob", }
scopes: Scope::Read,
website: None,
};
let mut registration = Registration::new("https://mastodon.social")?; fn run() -> mammut::Result<()> {
registration.register(app)?; let app = AppBuilder {
let url = registration.authorise()?; client_name: "mammut_test",
// Here you now need to open the url in the browser redirect_uris: "urn:ietf:wg:oauth:2.0:oob",
// And handle a the redirect url coming back with the code. scopes: Scope::Read,
let code = String::from("RETURNED_FROM_BROWSER"); website: None,
let mastodon = registration.create_access_token(code)?; };
println!("{:?}", mastodon.get_home_timeline()?); let mut registration = Registration::new("https://mastodon.social")?;
# Ok(()) registration.register(app)?;
# } let url = registration.authorise()?;
// Here you now need to open the url in the browser
// And handle a the redirect url coming back with the code.
let code = String::from("RETURNED_FROM_BROWSER");
let mastodon = registration.create_access_token(code)?;
println!("{:?}", mastodon.get_home_timeline()?);
Ok(())
}
``` ```

Loading…
Cancel
Save