Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
brokenedtzjs committed Dec 10, 2024
1 parent 2351cec commit d62a9d0
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 57 deletions.
65 changes: 36 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,36 @@
<div align="center">
<p>
<a href="https://www.npmjs.com/package/dc-rpc" target="_blank" rel="noopener noreferrer"><img src="https://nodei.co/npm/dc-rpc.png?downloads=true&downloadRank=true&stars=true"></a>
<a href="https://www.npmjs.com/package/dc-rpc" target="_blank" rel="noopener noreferrer"><img src="https://nodei.co/npm/dc-rpc.png?downloads=true&downloadRank=true&stars=true" /></a>
</p>
<p>
<a href="https://nodejs.org/" target="_blank" rel="noopener noreferrer"><img alt="node-current" src="https://img.shields.io/node/v/dc-rpc"></a>
<a href="https://www.npmjs.com/package/dc-rpc" target="_blank" rel="noopener noreferrer"><img alt="npm" src="https://img.shields.io/npm/dt/dc-rpc"></a>
<a href="https://www.npmjs.com/package/dc-rpc" target="_blank" rel="noopener noreferrer"><img alt="npm latest" src="https://img.shields.io/npm/v/dc-rpc/latest?color=blue&label=dc-rpc%40latest&logo=npm"></a>
<a href="https://github.com/skick1234/SITCommunity/discord-rpc" target="_blank" rel="noopener noreferrer"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/SITCommunity/discord-rpc"></a>
<a href="https://discord.gg/qpT2AeYZRN" target="_blank" rel="noopener noreferrer"><img alt="Discord" src="https://img.shields.io/discord/887650006977347594?label=EterNomm&logo=discord"></a>
<a href="https://discord.cyrateam.xyz" target="_blank" rel="noopener noreferrer"><img alt="Discord" src="https://img.shields.io/discord/984857299858382908?label=SITCommunity&logo=discord"></a>
<a href="https://github.com/SITCommunity/discord-rpc" target="_blank" rel="noopener noreferrer"><img alt="Visitor" src="https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2FCyraTeam%2Fdiscord-rpc&countColor=%2337d67a&style=flat"></a>
<a href="https://github.com/SITCommunity/discord-rpc/issues" target="_blank" rel="noopener noreferrer"><img alt="Issues" src="https://img.shields.io/github/issues/SITCommunity/discord-rpc"></a>
<a href="https://github.com/SITCommunity/discord-rpc" target="_blank" rel="noopener noreferrer"><img alt="Commit" src="https://img.shields.io/github/commit-activity/y/SITCommunity/discord-rpc?label=Commit%20Activity&logo=github"></a>
<a href="https://nodejs.org/" target="_blank" rel="noopener noreferrer"><img alt="node-current" src="https://img.shields.io/node/v/dc-rpc" /></a>
<a href="https://www.npmjs.com/package/dc-rpc" target="_blank" rel="noopener noreferrer"><img alt="npm" src="https://img.shields.io/npm/dt/dc-rpc" /></a>
<a href="https://www.npmjs.com/package/dc-rpc" target="_blank" rel="noopener noreferrer"><img alt="npm latest" src="https://img.shields.io/npm/v/dc-rpc/latest?color=blue&label=dc-rpc%40latest&logo=npm" /></a>
<a href="https://github.com/SITCommunity/discord-rpc" target="_blank" rel="noopener noreferrer"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/SITCommunity/discord-rpc" /></a>
<a href="https://discord.gg/qpT2AeYZRN" target="_blank" rel="noopener noreferrer"><img alt="Discord" src="https://img.shields.io/discord/887650006977347594?label=EterNomm&logo=discord" /></a>
<a href="https://discord.cyrateam.xyz" target="_blank" rel="noopener noreferrer"><img alt="Discord" src="https://img.shields.io/discord/984857299858382908?style=flat&logo=discord&logoColor=white&label=SITCommunity" /></a>
<a href="https://github.com/SITCommunity/discord-rpc" target="_blank" rel="noopener noreferrer"><img alt="Visitor" src="https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2FCyraTeam%2Fdiscord-rpc&countColor=%2337d67a&style=flat" /></a>
<a href="https://github.com/SITCommunity/discord-rpc/issues" target="_blank" rel="noopener noreferrer"><img alt="Issues" src="https://img.shields.io/github/issues/SITCommunity/discord-rpc" /></a>
<a href="https://github.com/SITCommunity/discord-rpc" target="_blank" rel="noopener noreferrer"><img alt="Commit" src="https://img.shields.io/github/commit-activity/y/SITCommunity/discord-rpc?label=Commit%20Activity&logo=github" /></a>
<a href="https://github.com/SITCommunity/discord-rpc/actions/workflows/test.yml"><img alt="Build" src="https://img.shields.io/github/actions/workflow/status/SITCommunity/discord-rpc/.github%2Fworkflows%2Ftest.yml" /></a>
<a href="https://github.com/SITCommunity/discord-rpc/blob/main/LICENSE"><img alt="Build" src="https://img.shields.io/npm/l/dc-rpc" /></a>
</p>
</div>

# Discord RPC

- **[Discord-RPC] is a powerful library developed by SITCommunity that enables developers to seamlessly integrate Rich Presence functionality into Discord applications or from Client ID**

## Install

- NPM

```
npm i dc-rpc
```

## Quick example

```js
// Importing Discord-RPC
const { RpcClient } = require('dc-rpc');
Expand All @@ -42,26 +48,26 @@ await client.login({ clientId: Id });

// ================================================================

// Logging When Client Is Ready
// Function When Client Is Ready
client.on('ready', () => {
console.log('Logged in as', client.application); // Console: Logged in as brokenedtz
console.log('Authed for user', client.user);
/** Console:
* Authed for user {
* id: 'user_id',
* username: 'brokenedtz',
* discriminator: '0',
* global_name: 'リオ',
* avatar: 'avatar_id',
* avatar_decoration_data: null,
* bot: false,
* flags: flag_id,
* premium_type: 0
* }
*/

// Set Activity (Example)
client.setActivity({ state: 'it work!!!', details: 'Testing RPC', startTimestamp: Date.now() });
console.log('Logged in as', client.application); // Console: Logged in as brokenedtz
console.log('Authed for user', client.user);
/** Console:
* Authed for user {
* id: 'user_id',
* username: 'brokenedtz',
* discriminator: '0',
* global_name: 'リオ',
* avatar: 'avatar_id',
* avatar_decoration_data: null,
* bot: false,
* flags: flag_id,
* premium_type: 0
* }
*/

// Set Activity (Example)
client.setActivity({ state: 'it work!!!', details: 'Testing RPC', startTimestamp: Date.now() });
});

// ================================================================
Expand All @@ -80,6 +86,7 @@ This Project under MIT License
```

## Credits

- Original: [Senophyx]
- Maintainer: [brokenedtz]

Expand Down
7 changes: 7 additions & 0 deletions packages/discord-rpc/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

All notable changes from Discord-RPC will be documented in this file.

## [unreleased]

### Bug Fixes

- Wrong timeout error code #5
- Typo on error code #4

## [1.5.8] - 2024-12-06

### New
Expand Down
63 changes: 35 additions & 28 deletions packages/discord-rpc/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,36 @@
<div align="center">
<p>
<a href="https://www.npmjs.com/package/dc-rpc" target="_blank" rel="noopener noreferrer"><img src="https://nodei.co/npm/dc-rpc.png?downloads=true&downloadRank=true&stars=true"></a>
<a href="https://www.npmjs.com/package/dc-rpc" target="_blank" rel="noopener noreferrer"><img src="https://nodei.co/npm/dc-rpc.png?downloads=true&downloadRank=true&stars=true" /></a>
</p>
<p>
<a href="https://nodejs.org/" target="_blank" rel="noopener noreferrer"><img alt="node-current" src="https://img.shields.io/node/v/distube"></a>
<a href="https://www.npmjs.com/package/dc-rpc" target="_blank" rel="noopener noreferrer"><img alt="npm" src="https://img.shields.io/npm/dt/dc-rpc"></a>
<a href="https://www.npmjs.com/package/dc-rpc" target="_blank" rel="noopener noreferrer"><img alt="npm latest" src="https://img.shields.io/npm/v/dc-rpc/latest?color=blue&label=dc-rpc%40latest&logo=npm"></a>
<a href="https://github.com/skick1234/SITCommunity/discord-rpc" target="_blank" rel="noopener noreferrer"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/SITCommunity/discord-rpc"></a>
<a href="https://discord.gg/qpT2AeYZRN" target="_blank" rel="noopener noreferrer"><img alt="Discord" src="https://img.shields.io/discord/984857299858382908?label=EterNomm&logo=discord"></a>
<a href="https://discord.cyrateam.xyz" target="_blank" rel="noopener noreferrer"><img alt="Discord" src="https://img.shields.io/discord/984857299858382908?label=SITCommunity&logo=discord"></a>
<a href="https://github.com/SITCommunity/discord-rpc" target="_blank" rel="noopener noreferrer"><img alt="Visitor" src="https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2FCyraTeam%2Fdiscord-rpc&countColor=%2337d67a&style=flat"></a>
<a href="https://github.com/SITCommunity/discord-rpc/issues" target="_blank" rel="noopener noreferrer"><img alt="Issues" src="https://img.shields.io/github/issues/SITCommunity/discord-rpc"></a>
<a href="https://github.com/SITCommunity/discord-rpc" target="_blank" rel="noopener noreferrer"><img alt="Commit" src="https://img.shields.io/github/commit-activity/y/SITCommunity/discord-rpc?label=Commit%20Activity&logo=github"></a>
<a href="https://nodejs.org/" target="_blank" rel="noopener noreferrer"><img alt="node-current" src="https://img.shields.io/node/v/dc-rpc" /></a>
<a href="https://www.npmjs.com/package/dc-rpc" target="_blank" rel="noopener noreferrer"><img alt="npm" src="https://img.shields.io/npm/dt/dc-rpc" /></a>
<a href="https://www.npmjs.com/package/dc-rpc" target="_blank" rel="noopener noreferrer"><img alt="npm latest" src="https://img.shields.io/npm/v/dc-rpc/latest?color=blue&label=dc-rpc%40latest&logo=npm" /></a>
<a href="https://github.com/SITCommunity/discord-rpc" target="_blank" rel="noopener noreferrer"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/SITCommunity/discord-rpc" /></a>
<a href="https://discord.gg/qpT2AeYZRN" target="_blank" rel="noopener noreferrer"><img alt="Discord" src="https://img.shields.io/discord/887650006977347594?label=EterNomm&logo=discord" /></a>
<a href="https://discord.cyrateam.xyz" target="_blank" rel="noopener noreferrer"><img alt="Discord" src="https://img.shields.io/discord/984857299858382908?style=flat&logo=discord&logoColor=white&label=SITCommunity" /></a>
<a href="https://github.com/SITCommunity/discord-rpc" target="_blank" rel="noopener noreferrer"><img alt="Visitor" src="https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2FCyraTeam%2Fdiscord-rpc&countColor=%2337d67a&style=flat" /></a>
<a href="https://github.com/SITCommunity/discord-rpc/issues" target="_blank" rel="noopener noreferrer"><img alt="Issues" src="https://img.shields.io/github/issues/SITCommunity/discord-rpc" /></a>
<a href="https://github.com/SITCommunity/discord-rpc" target="_blank" rel="noopener noreferrer"><img alt="Commit" src="https://img.shields.io/github/commit-activity/y/SITCommunity/discord-rpc?label=Commit%20Activity&logo=github" /></a>
<a href="https://github.com/SITCommunity/discord-rpc/actions/workflows/test.yml"><img alt="Build" src="https://img.shields.io/github/actions/workflow/status/SITCommunity/discord-rpc/.github%2Fworkflows%2Ftest.yml" /></a>
<a href="https://github.com/SITCommunity/discord-rpc/blob/main/LICENSE"><img alt="Build" src="https://img.shields.io/npm/l/dc-rpc" /></a>
</p>
</div>

# Discord RPC

- **[Discord-RPC] is a powerful library developed by SITCommunity that enables developers to seamlessly integrate Rich Presence functionality into Discord applications or from Client ID**

## Install

- NPM

```
npm i dc-rpc
```

## Quick example

```js
// Importing Discord-RPC
const { RpcClient } = require('dc-rpc');
Expand All @@ -44,24 +50,24 @@ await client.login({ clientId: Id });

// Function When Client Is Ready
client.on('ready', () => {
console.log('Logged in as', client.application); // Console: Logged in as brokenedtz
console.log('Authed for user', client.user);
/** Console:
* Authed for user {
* id: 'user_id',
* username: 'brokenedtz',
* discriminator: '0',
* global_name: 'リオ',
* avatar: 'avatar_id',
* avatar_decoration_data: null,
* bot: false,
* flags: flag_id,
* premium_type: 0
* }
*/

// Set Activity (Example)
client.setActivity({ state: 'it work!!!', details: 'Testing RPC', startTimestamp: Date.now() });
console.log('Logged in as', client.application); // Console: Logged in as brokenedtz
console.log('Authed for user', client.user);
/** Console:
* Authed for user {
* id: 'user_id',
* username: 'brokenedtz',
* discriminator: '0',
* global_name: 'リオ',
* avatar: 'avatar_id',
* avatar_decoration_data: null,
* bot: false,
* flags: flag_id,
* premium_type: 0
* }
*/

// Set Activity (Example)
client.setActivity({ state: 'it work!!!', details: 'Testing RPC', startTimestamp: Date.now() });
});

// ================================================================
Expand All @@ -80,6 +86,7 @@ This Project under MIT License
```

## Credits

- Original: [Senophyx]
- Maintainer: [brokenedtz]

Expand Down

0 comments on commit d62a9d0

Please sign in to comment.