michael/discord-rpc-client
michael
/
discord-rpc-client
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Update readme

This commit is contained in:
Patrick Auernig 2018-12-06 01:27:39 +01:00
parent 4b99188f23
commit 52d31f4420
1 changed files with 34 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -1,9 +1,11 @@
[![Build Status][travis-ci-badge]][travis-ci-page] [![Build status][appveyor-ci-badge]][appveyor-ci-page] [![crates.io][crates-io-badge]][crates-io-page] [![Discord][discord-badge]][discord-invite]
[![Build Status][travis-ci-badge]][travis-ci-page] [![Build status][appveyor-ci-badge]][appveyor-ci-page] [![crates.io][crates-io-badge-ver]][crates-io-page] [![crates.io][crates-io-badge-dl]][crates-io-page] [![Discord][discord-badge]][discord-invite]
# Discord RPC Client
Discord RPC client for Rust
## Installation
Add this to your `Cargo.toml`:
@ -13,9 +15,36 @@ Add this to your `Cargo.toml`:
discord-rpc-client = "^0.2"
```
## Examples
Examples can be found in the examples directory in this repo.
## Example
```rust
extern crate discord_rpc_client;
use std::{env, thread, time};
use discord_rpc_client::Client;
fn main() {
// Get our main status message
let state_message = env::args().nth(1).expect("Requires at least one argument");
// Create the client
let mut drpc = Client::new(425407036495495169);
// Start up the client connection, so that we can actually send and receive stuff
drpc.start();
// Set the activity
drpc.set_activity(|act| act.state(state_message))
.expect("Failed to set activity");
// Wait 10 seconds before exiting
thread::sleep(time::Duration::from_secs(10));
}
```
> More examples can be found in the examples directory.
## Contributions
@ -26,7 +55,8 @@ See [CONTRIBUTING.md](CONTRIBUTING.md)
[gitlab-ci-badge]: https://gitlab.com/valeth/discord-rpc-client.rs/badges/master/pipeline.svg
[gitlab-repo-master]: https://gitlab.com/valeth/discord-rpc-client.rs/commits/master
[crates-io-badge]: https://img.shields.io/crates/v/discord-rpc-client.svg
[crates-io-badge-ver]: https://img.shields.io/crates/v/discord-rpc-client.svg
[crates-io-badge-dl]: https://img.shields.io/crates/d/discord-rpc-client.svg
[crates-io-page]: https://crates.io/crates/discord-rpc-client
[travis-ci-badge]: https://travis-ci.org/valeth/discord-rpc-client.rs.svg?branch=master
[travis-ci-page]: https://travis-ci.org/valeth/discord-rpc-client.rs