AmokDev/rust-discord-rpc
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Обновить README.md

Browse source
This commit is contained in:
AmokDev 2025-03-18 07:32:39 +00:00
parent 40afb802b2
commit 781b9779a2
1 changed files with 6 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -1,13 +1,12 @@
# Rust Discord Activity
_A lightweight Rust library to control Discord Rich Presence_
[![crates.io](https://img.shields.io/crates/v/rust-discord-activity.svg)](https://crates.io/crates/rust-discord-activity)
[![maintenance-status](https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg)](https://crates.io/crates/rust-discord-activity)
[![docs.rs](https://img.shields.io/docsrs/rust-discord-activity)](https://docs.rs/rust-discord-activity/latest)
[Author of the idea and 80% code](https://github.com/DylanCa/rust-discord-activity)
## Installation
Rust Discord Activity is available directly on [crates.io](https://crates.io/crates/rust-discord-activity):
`cargo add rust-discord-activity`
```bash
cargo add --git https://git.amok.dev/AmokDev/rust-discord-rpc
```
## How to use
1. Instantiate a new DiscordClient
@ -15,8 +14,6 @@ Rust Discord Activity is available directly on [crates.io](https://crates.io/cra
3. Create a new Payload with your Activity
4. Send your Payload through the DiscordClient
Et voilà !
## Example
```rust
let mut client = DiscordClient::new("<application_id>");
@ -52,9 +49,9 @@ let _ = client.send_payload(payload);
```
And voilà! This sets-up a new Activity for the current Discord user:
This sets-up a new Activity for the current Discord user:
<img alt="Discord Rich Presence" src="https://imgur.com/gf9pOen.png" width="300"/>
## Limitations
## Limits
For the moment, the library only works with WINDOWS (suck UNIXoids 🖕) and local Discord application.