Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-09 16:13:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

chore: overhaul readmes (#9277)

Browse Source 
Co-authored-by: Souji <timoqueezle@gmail.com>
Co-authored-by: Noel <buechler.noel@outlook.com>
This commit is contained in:
Tetie
2023-04-01 13:45:15 +02:00
committed by GitHub
parent a5b0d97224
commit 74a6d59ae9
21 changed files with 138 additions and 197 deletions
Download Patch File Download Diff File Expand all files Collapse all files

119
README.md
View File

@@ -18,96 +18,28 @@
## About ## About
discord.js is a powerful [Node.js](https://nodejs.org) module that allows you to easily interact with the This repository contains multiple packages with separate [releases][github-releases]. You can find the assembled Discord API wrapper at [`discord.js`][source]. It is a powerful [Node.js](https://nodejs.org/en) module that allows you to easily interact with the [Discord API](https://discord.com/developers/docs/intro).
[Discord API](https://discord.com/developers/docs/intro).
- Object-oriented ## Packages
- Predictable abstractions
- Performant
- 100% coverage of the Discord API
## Installation - `discord.js` ([source][source]) - A powerful Node.js module for interacting with the Discord API
- `@discordjs/brokers` ([source][brokers-source]) - A collection of brokers for use with discord.js
**Node.js 16.9.0 or newer is required.** - `@discordjs/builders` ([source][builders-source]) - A utility package for easily building Discord API payloads
- `@discordjs/collection` ([source][collection-source]) - A powerful utility data structure
```sh - `@discordjs/core` ([source][core-source]) - A thinly abstracted wrapper around the core components of the Discord API
npm install discord.js - `@discordjs/formatters` ([source][formatters-source]) - A collection of functions for formatting strings
yarn add discord.js - `@discordjs/proxy` ([source][proxy-source]) - A wrapper around `@discordjs/rest` for running an HTTP proxy
pnpm add discord.js - `@discordjs/rest` ([source][rest-source]) - A module for interacting with the Discord REST API
``` - `@discordjs/voice` ([source][voice-source]) - A module for interacting with the Discord Voice API
- `@discordjs/util` ([source][util-source]) - A collection of utility functions
### Optional packages - `@discordjs/ws` ([source][ws-source]) - A wrapper around Discord's gateway
- [zlib-sync](https://www.npmjs.com/package/zlib-sync) for WebSocket data compression and inflation (`npm install zlib-sync`)
- [erlpack](https://github.com/discord/erlpack) for significantly faster WebSocket data (de)serialisation (`npm install discord/erlpack`)
- [bufferutil](https://www.npmjs.com/package/bufferutil) for a much faster WebSocket connection (`npm install bufferutil`)
- [utf-8-validate](https://www.npmjs.com/package/utf-8-validate) in combination with `bufferutil` for much faster WebSocket processing (`npm install utf-8-validate`)
- [@discordjs/voice](https://www.npmjs.com/package/@discordjs/voice) for interacting with the Discord Voice API (`npm install @discordjs/voice`)
## Example usage
Install discord.js:
```sh
npm install discord.js
yarn add discord.js
pnpm add discord.js
```
Register a slash command against the Discord API:
```js
const { REST, Routes } = require('discord.js');
const commands = [
{
name: 'ping',
description: 'Replies with Pong!',
},
];
const rest = new REST({ version: '10' }).setToken(TOKEN);
(async () => {
try {
console.log('Started refreshing application (/) commands.');
await rest.put(Routes.applicationCommands(CLIENT_ID), { body: commands });
console.log('Successfully reloaded application (/) commands.');
} catch (error) {
console.error(error);
}
})();
```
Afterwards we can create a quite simple example bot:
```js
const { Client, GatewayIntentBits } = require('discord.js');
const client = new Client({ intents: [GatewayIntentBits.Guilds] });
client.on('ready', () => {
console.log(`Logged in as ${client.user.tag}!`);
});
client.on('interactionCreate', async (interaction) => {
if (!interaction.isChatInputCommand()) return;
if (interaction.commandName === 'ping') {
await interaction.reply('Pong!');
}
});
client.login(TOKEN);
```
## Links ## Links
- [Website][website] ([source][website-source]) - [Website][website] ([source][website-source])
- [Documentation][documentation] - [Documentation][documentation]
- [Guide][guide] ([source][guide-source]) - [Guide][guide] ([source][guide-source])
See also the [Update Guide][guide-update], including updated and removed items in the library. Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
- [discord.js Discord server][discord] - [discord.js Discord server][discord]
- [Discord API Discord server][discord-api] - [Discord API Discord server][discord-api]
- [GitHub][source] - [GitHub][source]
@@ -120,18 +52,15 @@ client.login(TOKEN);
## Contributing ## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the Please read through our [contribution guidelines][contributing] before starting a pull request. We welcome contributions of all kinds, not just code! If you're stuck for ideas, look for the [good first issue][good-first-issue] label on issues in the repository. If you have any questions about the project, feel free to ask them on [Discord][discord]. Before creating your own issue or pull request, always check to see if one already exists! Don't rush contributions, take your time and ensure you're doing it correctly.
[documentation][documentation].
See [the contribution guide][contributing] if you'd like to submit a PR.
## Help ## Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please join our [Discord server][discord].
nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
[website]: https://discord.js.org/ [website]: https://discord.js.org
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
[documentation]: https://discord.js.org/#/docs [documentation]: https://discord.js.org/docs
[guide]: https://discordjs.guide/ [guide]: https://discordjs.guide/
[guide-source]: https://github.com/discordjs/guide [guide-source]: https://github.com/discordjs/guide
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html
@@ -143,3 +72,15 @@ nudge in the right direction, please don't hesitate to join our official [discor
[rpc]: https://www.npmjs.com/package/discord-rpc [rpc]: https://www.npmjs.com/package/discord-rpc
[rpc-source]: https://github.com/discordjs/RPC [rpc-source]: https://github.com/discordjs/RPC
[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md [contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md
[github-releases]: https://github.com/discordjs/discord.js/releases
[brokers-source]: https://github.com/discordjs/discord.js/tree/main/packages/brokers
[builders-source]: https://github.com/discordjs/discord.js/tree/main/packages/builders
[collection-source]: https://github.com/discordjs/discord.js/tree/main/packages/collection
[core-source]: https://github.com/discordjs/discord.js/tree/main/packages/core
[formatters-source]: https://github.com/discordjs/discord.js/tree/main/packages/formatters
[proxy-source]: https://github.com/discordjs/discord.js/tree/main/packages/proxy
[rest-source]: https://github.com/discordjs/discord.js/tree/main/packages/rest
[voice-source]: https://github.com/discordjs/discord.js/tree/main/packages/voice
[util-source]: https://github.com/discordjs/discord.js/tree/main/packages/util
[ws-source]: https://github.com/discordjs/discord.js/tree/main/packages/ws
[good-first-issue]: https://github.com/discordjs/discord.js/contribute

15
apps/guide/README.md
View File

@@ -13,12 +13,16 @@
</p> </p>
</div> </div>
## About
The official guide for discord.js, made to help you get started easily with the library.
## Links ## Links
- [Website][website] ([source][website-source]) - [Website][website] ([source][website-source])
- [Documentation][documentation] - [Documentation][documentation]
- [Guide][guide] ([source][guide-source]) - [Guide][guide] ([source][guide-source])
See also the [Update Guide][guide-update], including updated and removed items in the library. Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
- [discord.js Discord server][discord] - [discord.js Discord server][discord]
- [Discord API Discord server][discord-api] - [Discord API Discord server][discord-api]
- [GitHub][source] - [GitHub][source]
@@ -26,16 +30,17 @@
## Contributing ## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
[documentation][documentation].
See [the contribution guide][contributing] if you'd like to submit a PR. See [the contribution guide][contributing] if you'd like to submit a PR.
## Help ## Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
[website]: https://discord.js.org/ [website]: https://discord.js.org
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
[documentation]: https://discord.js.org/ [documentation]: https://discord.js.org/docs
[guide]: https://discordjs.guide/ [guide]: https://discordjs.guide/
[guide-source]: https://github.com/discordjs/guide [guide-source]: https://github.com/discordjs/guide
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html

11
apps/website/README.md
View File

@@ -18,7 +18,7 @@
- [Website][website] ([source][website-source]) - [Website][website] ([source][website-source])
- [Documentation][documentation] - [Documentation][documentation]
- [Guide][guide] ([source][guide-source]) - [Guide][guide] ([source][guide-source])
See also the [Update Guide][guide-update], including updated and removed items in the library. Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
- [discord.js Discord server][discord] - [discord.js Discord server][discord]
- [Discord API Discord server][discord-api] - [Discord API Discord server][discord-api]
- [GitHub][source] - [GitHub][source]
@@ -26,16 +26,17 @@
## Contributing ## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
[documentation][documentation].
See [the contribution guide][contributing] if you'd like to submit a PR. See [the contribution guide][contributing] if you'd like to submit a PR.
## Help ## Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
[website]: https://discord.js.org/ [website]: https://discord.js.org
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
[documentation]: https://discord.js.org/ [documentation]: https://discord.js.org/docs
[guide]: https://discordjs.guide/ [guide]: https://discordjs.guide/
[guide-source]: https://github.com/discordjs/guide [guide-source]: https://github.com/discordjs/guide
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html

11
packages/actions/README.md
View File

@@ -16,9 +16,8 @@
## Links ## Links
- [Website][website] ([source][website-source]) - [Website][website] ([source][website-source])
- [Documentation][documentation]
- [Guide][guide] ([source][guide-source]) - [Guide][guide] ([source][guide-source])
See also the [Update Guide][guide-update], including updated and removed items in the library. Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
- [discord.js Discord server][discord] - [discord.js Discord server][discord]
- [Discord API Discord server][discord-api] - [Discord API Discord server][discord-api]
- [GitHub][source] - [GitHub][source]
@@ -26,16 +25,16 @@
## Contributing ## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
[documentation][documentation].
See [the contribution guide][contributing] if you'd like to submit a PR. See [the contribution guide][contributing] if you'd like to submit a PR.
## Help ## Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
[website]: https://discord.js.org/ [website]: https://discord.js.org
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
[documentation]: https://discord.js.org/#/docs
[guide]: https://discordjs.guide/ [guide]: https://discordjs.guide/
[guide-source]: https://github.com/discordjs/guide [guide-source]: https://github.com/discordjs/guide
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html

11
packages/api-extractor-utils/README.md
View File

@@ -16,9 +16,8 @@
## Links ## Links
- [Website][website] ([source][website-source]) - [Website][website] ([source][website-source])
- [Documentation][documentation]
- [Guide][guide] ([source][guide-source]) - [Guide][guide] ([source][guide-source])
See also the [Update Guide][guide-update], including updated and removed items in the library. Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
- [discord.js Discord server][discord] - [discord.js Discord server][discord]
- [Discord API Discord server][discord-api] - [Discord API Discord server][discord-api]
- [GitHub][source] - [GitHub][source]
@@ -26,16 +25,16 @@
## Contributing ## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
[documentation][documentation].
See [the contribution guide][contributing] if you'd like to submit a PR. See [the contribution guide][contributing] if you'd like to submit a PR.
## Help ## Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
[website]: https://discord.js.org/ [website]: https://discord.js.org
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
[documentation]: https://discord.js.org/#/docs
[guide]: https://discordjs.guide/ [guide]: https://discordjs.guide/
[guide-source]: https://github.com/discordjs/guide [guide-source]: https://github.com/discordjs/guide
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html

9
packages/brokers/README.md
View File

@@ -88,7 +88,7 @@ await broker.subscribe('responders', ['testcall']);
- [Website][website] ([source][website-source]) - [Website][website] ([source][website-source])
- [Documentation][documentation] - [Documentation][documentation]
- [Guide][guide] ([source][guide-source]) - [Guide][guide] ([source][guide-source])
See also the [Update Guide][guide-update], including updated and removed items in the library. Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
- [discord.js Discord server][discord] - [discord.js Discord server][discord]
- [Discord API Discord server][discord-api] - [Discord API Discord server][discord-api]
- [GitHub][source] - [GitHub][source]
@@ -103,12 +103,11 @@ See [the contribution guide][contributing] if you'd like to submit a PR.
## Help ## Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
[website]: https://discord.js.org/ [website]: https://discord.js.org
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
[documentation]: https://discord.js.org/#/docs/brokers [documentation]: https://discord.js.org/docs/packages/brokers/stable
[guide]: https://discordjs.guide/ [guide]: https://discordjs.guide/
[guide-source]: https://github.com/discordjs/guide [guide-source]: https://github.com/discordjs/guide
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html

17
packages/builders/README.md
View File

@@ -16,6 +16,10 @@
</p> </p>
</div> </div>
## About
`@discord.js/builders` is a utility package for easily building Discord API payloads.
## Installation ## Installation
**Node.js 16.9.0 or newer is required.** **Node.js 16.9.0 or newer is required.**
@@ -28,16 +32,14 @@ pnpm add @discordjs/builders
## Examples ## Examples
Here are some examples for the builders and utilities you can find in this package: You can find examples of how to use the builders in the [Slash Command Builders][example] examples.
- [Slash Command Builders][example]
## Links ## Links
- [Website][website] ([source][website-source]) - [Website][website] ([source][website-source])
- [Documentation][documentation] - [Documentation][documentation]
- [Guide][guide] ([source][guide-source]) - [Guide][guide] ([source][guide-source])
See also the [Update Guide][guide-update], including updated and removed items in the library. Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
- [discord.js Discord server][discord] - [discord.js Discord server][discord]
- [Discord API Discord server][discord-api] - [Discord API Discord server][discord-api]
- [GitHub][source] - [GitHub][source]
@@ -52,13 +54,12 @@ See [the contribution guide][contributing] if you'd like to submit a PR.
## Help ## Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
[example]: https://github.com/discordjs/discord.js/blob/main/packages/builders/docs/examples/Slash%20Command%20Builders.md [example]: https://github.com/discordjs/discord.js/blob/main/packages/builders/docs/examples/Slash%20Command%20Builders.md
[website]: https://discord.js.org/ [website]: https://discord.js.org
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
[documentation]: https://discord.js.org/#/docs/builders [documentation]: https://discord.js.org/docs/packages/builders/stable
[guide]: https://discordjs.guide/ [guide]: https://discordjs.guide/
[guide-source]: https://github.com/discordjs/guide [guide-source]: https://github.com/discordjs/guide
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html

9
packages/collection/README.md
View File

@@ -35,7 +35,7 @@ pnpm add @discordjs/collection
- [Website][website] ([source][website-source]) - [Website][website] ([source][website-source])
- [Documentation][documentation] - [Documentation][documentation]
- [Guide][guide] ([source][guide-source]) - [Guide][guide] ([source][guide-source])
See also the [Update Guide][guide-update], including updated and removed items in the library. Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
- [discord.js Discord server][discord] - [discord.js Discord server][discord]
- [Discord API Discord server][discord-api] - [Discord API Discord server][discord-api]
- [GitHub][source] - [GitHub][source]
@@ -50,12 +50,11 @@ See [the contribution guide][contributing] if you'd like to submit a PR.
## Help ## Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
[website]: https://discord.js.org/ [website]: https://discord.js.org
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
[documentation]: https://discord.js.org/#/docs/collection [documentation]: https://discord.js.org/docs/packages/collection/stable
[guide]: https://discordjs.guide/ [guide]: https://discordjs.guide/
[guide-source]: https://github.com/discordjs/guide [guide-source]: https://github.com/discordjs/guide
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html

9
packages/core/README.md
View File

@@ -83,7 +83,7 @@ const guild = await api.guilds.get('1234567891011');
- [Website][website] ([source][website-source]) - [Website][website] ([source][website-source])
- [Documentation][documentation] - [Documentation][documentation]
- [Guide][guide] ([source][guide-source]) - [Guide][guide] ([source][guide-source])
See also the [Update Guide][guide-update], including updated and removed items in the library. Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
- [discord.js Discord server][discord] - [discord.js Discord server][discord]
- [Discord API Discord server][discord-api] - [Discord API Discord server][discord-api]
- [GitHub][source] - [GitHub][source]
@@ -98,12 +98,11 @@ See [the contribution guide][contributing] if you'd like to submit a PR.
## Help ## Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
[website]: https://discord.js.org/ [website]: https://discord.js.org
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
[documentation]: https://discord.js.org/ [documentation]: https://discord.js.org/docs/packages/core/stable
[guide]: https://discordjs.guide/ [guide]: https://discordjs.guide/
[guide-source]: https://github.com/discordjs/guide [guide-source]: https://github.com/discordjs/guide
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html

9
packages/discord.js/README.md
View File

@@ -107,7 +107,7 @@ client.login(TOKEN);
- [Website][website] ([source][website-source]) - [Website][website] ([source][website-source])
- [Documentation][documentation] - [Documentation][documentation]
- [Guide][guide] ([source][guide-source]) - [Guide][guide] ([source][guide-source])
See also the [Update Guide][guide-update], including updated and removed items in the library. Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
- [discord.js Discord server][discord] - [discord.js Discord server][discord]
- [Discord API Discord server][discord-api] - [Discord API Discord server][discord-api]
- [GitHub][source] - [GitHub][source]
@@ -126,12 +126,11 @@ See [the contribution guide][contributing] if you'd like to submit a PR.
## Help ## Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
[website]: https://discord.js.org/ [website]: https://discord.js.org
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
[documentation]: https://discord.js.org/#/docs [documentation]: https://discord.js.org/docs/packages/discord.js/stable
[guide]: https://discordjs.guide/ [guide]: https://discordjs.guide/
[guide-source]: https://github.com/discordjs/guide [guide-source]: https://github.com/discordjs/guide
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html

10
packages/docgen/README.md
View File

@@ -18,7 +18,7 @@
- [Website][website] ([source][website-source]) - [Website][website] ([source][website-source])
- [Documentation][documentation] - [Documentation][documentation]
- [Guide][guide] ([source][guide-source]) - [Guide][guide] ([source][guide-source])
See also the [Update Guide][guide-update], including updated and removed items in the library. Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
- [discord.js Discord server][discord] - [discord.js Discord server][discord]
- [Discord API Discord server][discord-api] - [Discord API Discord server][discord-api]
- [GitHub][source] - [GitHub][source]
@@ -27,16 +27,16 @@
## Contributing ## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
[documentation][documentation].
See [the contribution guide][contributing] if you'd like to submit a PR. See [the contribution guide][contributing] if you'd like to submit a PR.
## Help ## Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
[website]: https://discord.js.org/ [website]: https://discord.js.org
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
[documentation]: https://discord.js.org/
[guide]: https://discordjs.guide/ [guide]: https://discordjs.guide/
[guide-source]: https://github.com/discordjs/guide [guide-source]: https://github.com/discordjs/guide
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html

8
packages/formatters/README.md
View File

@@ -18,7 +18,7 @@
## About ## About
`@discordjs/formatters` set of functions to format strings for Discord. `@discordjs/formatters` is a collection of functions for formatting strings to be used on Discord.
## Installation ## Installation
@@ -49,7 +49,7 @@ console.log(formattedCode);
- [Website][website] ([source][website-source]) - [Website][website] ([source][website-source])
- [Documentation][documentation] - [Documentation][documentation]
- [Guide][guide] ([source][guide-source]) - [Guide][guide] ([source][guide-source])
See also the [Update Guide][guide-update], including updated and removed items in the library. Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
- [discord.js Discord server][discord] - [discord.js Discord server][discord]
- [Discord API Discord server][discord-api] - [Discord API Discord server][discord-api]
- [GitHub][source] - [GitHub][source]
@@ -66,9 +66,9 @@ See [the contribution guide][contributing] if you'd like to submit a PR.
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord]. If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
[website]: https://discord.js.org/ [website]: https://discord.js.org
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
[documentation]: https://discord.js.org/ [documentation]: https://discord.js.org/docs/packages/formatters/stable
[guide]: https://discordjs.guide/ [guide]: https://discordjs.guide/
[guide-source]: https://github.com/discordjs/guide [guide-source]: https://github.com/discordjs/guide
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html

10
packages/next/README.md
View File

@@ -26,9 +26,8 @@ pnpm add @discordjs/next
## Links ## Links
- [Website][website] ([source][website-source]) - [Website][website] ([source][website-source])
- [Documentation][documentation]
- [Guide][guide] ([source][guide-source]) - [Guide][guide] ([source][guide-source])
See also the [Update Guide][guide-update], including updated and removed items in the library. Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
- [discord.js Discord server][discord] - [discord.js Discord server][discord]
- [Discord API Discord server][discord-api] - [Discord API Discord server][discord-api]
- [GitHub][source] - [GitHub][source]
@@ -43,12 +42,11 @@ See [the contribution guide][contributing] if you'd like to submit a PR.
## Help ## Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
[website]: https://discord.js.org/ [website]: https://discord.js.org
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
[documentation]: https://discord.js.org/#/docs/next [documentation]: https://discord.js.org/docs/packages/next/stable
[guide]: https://discordjs.guide/ [guide]: https://discordjs.guide/
[guide-source]: https://github.com/discordjs/guide [guide-source]: https://github.com/discordjs/guide
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html

10
packages/proxy-container/README.md
View File

@@ -53,7 +53,7 @@ const rest = new REST({
- [Website][website] ([source][website-source]) - [Website][website] ([source][website-source])
- [Documentation][documentation] - [Documentation][documentation]
- [Guide][guide] ([source][guide-source]) - [Guide][guide] ([source][guide-source])
See also the [Update Guide][guide-update], including updated and removed items in the library. Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
- [discord.js Discord server][discord] - [discord.js Discord server][discord]
- [Discord API Discord server][discord-api] - [Discord API Discord server][discord-api]
- [GitHub][source] - [GitHub][source]
@@ -61,16 +61,16 @@ const rest = new REST({
## Contributing ## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
[documentation][documentation].
See [the contribution guide][contributing] if you'd like to submit a PR. See [the contribution guide][contributing] if you'd like to submit a PR.
## Help ## Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
[website]: https://discord.js.org/ [website]: https://discord.js.org
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
[documentation]: https://discord.js.org/
[guide]: https://discordjs.guide/ [guide]: https://discordjs.guide/
[guide-source]: https://github.com/discordjs/guide [guide-source]: https://github.com/discordjs/guide
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html

11
packages/proxy/README.md
View File

@@ -18,7 +18,7 @@
## About ## About
`@discordjs/proxy` is a powerful wrapper around `@discordjs/rest` for running an HTTP proxy in front of Discord's API `@discordjs/proxy` is a powerful wrapper around `@discordjs/rest` for running an HTTP proxy in front of Discord's API.
## Installation ## Installation
@@ -35,7 +35,7 @@ pnpm add @discordjs/proxy
- [Website][website] ([source][website-source]) - [Website][website] ([source][website-source])
- [Documentation][documentation] - [Documentation][documentation]
- [Guide][guide] ([source][guide-source]) - [Guide][guide] ([source][guide-source])
See also the [Update Guide][guide-update], including updated and removed items in the library. Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
- [discord.js Discord server][discord] - [discord.js Discord server][discord]
- [Discord API Discord server][discord-api] - [Discord API Discord server][discord-api]
- [GitHub][source] - [GitHub][source]
@@ -50,12 +50,11 @@ See [the contribution guide][contributing] if you'd like to submit a PR.
## Help ## Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
[website]: https://discord.js.org/ [website]: https://discord.js.org
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
[documentation]: https://discord.js.org/#/docs/proxy [documentation]: https://discord.js.org/docs/packages/proxy/stable
[guide]: https://discordjs.guide/ [guide]: https://discordjs.guide/
[guide-source]: https://github.com/discordjs/guide [guide-source]: https://github.com/discordjs/guide
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html

13
packages/rest/README.md
View File

@@ -16,6 +16,10 @@
</p> </p>
</div> </div>
## About
`@discord.js/rest` is a module that allows you to easily make REST requests to the Discord API.
## Installation ## Installation
**Node.js 16.9.0 or newer is required.** **Node.js 16.9.0 or newer is required.**
@@ -80,7 +84,7 @@ try {
- [Website][website] ([source][website-source]) - [Website][website] ([source][website-source])
- [Documentation][documentation] - [Documentation][documentation]
- [Guide][guide] ([source][guide-source]) - [Guide][guide] ([source][guide-source])
See also the [Update Guide][guide-update], including updated and removed items in the library. Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
- [discord.js Discord server][discord] - [discord.js Discord server][discord]
- [Discord API Discord server][discord-api] - [Discord API Discord server][discord-api]
- [GitHub][source] - [GitHub][source]
@@ -95,12 +99,11 @@ See [the contribution guide][contributing] if you'd like to submit a PR.
## Help ## Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
[website]: https://discord.js.org/ [website]: https://discord.js.org
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
[documentation]: https://discord.js.org/#/docs/rest [documentation]: https://discord.js.org/docs/packages/rest/stable
[guide]: https://discordjs.guide/ [guide]: https://discordjs.guide/
[guide-source]: https://github.com/discordjs/guide [guide-source]: https://github.com/discordjs/guide
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html

10
packages/scripts/README.md
View File

@@ -16,9 +16,8 @@
## Links ## Links
- [Website][website] ([source][website-source]) - [Website][website] ([source][website-source])
- [Documentation][documentation]
- [Guide][guide] ([source][guide-source]) - [Guide][guide] ([source][guide-source])
See also the [Update Guide][guide-update], including updated and removed items in the library. Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
- [discord.js Discord server][discord] - [discord.js Discord server][discord]
- [Discord API Discord server][discord-api] - [Discord API Discord server][discord-api]
- [GitHub][source] - [GitHub][source]
@@ -26,16 +25,15 @@
## Contributing ## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the[documentation][documentation].
See [the contribution guide][contributing] if you'd like to submit a PR. See [the contribution guide][contributing] if you'd like to submit a PR.
## Help ## Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
[website]: https://discord.js.org/ [website]: https://discord.js.org
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
[documentation]: https://discord.js.org/#/docs/scripts
[guide]: https://discordjs.guide/ [guide]: https://discordjs.guide/
[guide-source]: https://github.com/discordjs/guide [guide-source]: https://github.com/discordjs/guide
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html

10
packages/ui/README.md
View File

@@ -18,7 +18,7 @@
- [Website][website] ([source][website-source]) - [Website][website] ([source][website-source])
- [Documentation][documentation] - [Documentation][documentation]
- [Guide][guide] ([source][guide-source]) - [Guide][guide] ([source][guide-source])
See also the [Update Guide][guide-update], including updated and removed items in the library. Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
- [discord.js Discord server][discord] - [discord.js Discord server][discord]
- [Discord API Discord server][discord-api] - [Discord API Discord server][discord-api]
- [GitHub][source] - [GitHub][source]
@@ -26,16 +26,16 @@
## Contributing ## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
[documentation][documentation].
See [the contribution guide][contributing] if you'd like to submit a PR. See [the contribution guide][contributing] if you'd like to submit a PR.
## Help ## Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
[website]: https://discord.js.org/ [website]: https://discord.js.org
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
[documentation]: https://discord.js.org/
[guide]: https://discordjs.guide/ [guide]: https://discordjs.guide/
[guide-source]: https://github.com/discordjs/guide [guide-source]: https://github.com/discordjs/guide
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html

13
packages/util/README.md
View File

@@ -13,6 +13,10 @@
</p> </p>
</div> </div>
## About
`@discordjs/util` is a collection of utility functions for use with discord.js.
## Installation ## Installation
**Node.js 16.9.0 or newer is required.** **Node.js 16.9.0 or newer is required.**
@@ -28,7 +32,7 @@ pnpm add @discordjs/util
- [Website][website] ([source][website-source]) - [Website][website] ([source][website-source])
- [Documentation][documentation] - [Documentation][documentation]
- [Guide][guide] ([source][guide-source]) - [Guide][guide] ([source][guide-source])
See also the [Update Guide][guide-update], including updated and removed items in the library. Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
- [discord.js Discord server][discord] - [discord.js Discord server][discord]
- [Discord API Discord server][discord-api] - [Discord API Discord server][discord-api]
- [GitHub][source] - [GitHub][source]
@@ -43,12 +47,11 @@ See [the contribution guide][contributing] if you'd like to submit a PR.
## Help ## Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
[website]: https://discord.js.org/ [website]: https://discord.js.org
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
[documentation]: https://discord.js.org/#/docs/util [documentation]: https://discord.js.org/docs/packages/util/stable
[guide]: https://discordjs.guide/ [guide]: https://discordjs.guide/
[guide-source]: https://github.com/discordjs/guide [guide-source]: https://github.com/discordjs/guide
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html

11
packages/voice/README.md
View File

@@ -18,7 +18,7 @@
## About ## About
An implementation of the Discord Voice API for Node.js, written in TypeScript. `@discordjs/voice` is a TypeScript implementation of the Discord Voice API for Node.js.
**Features:** **Features:**
@@ -73,7 +73,7 @@ The [voice-examples][voice-examples] repository contains examples on how to use
- [Website][website] ([source][website-source]) - [Website][website] ([source][website-source])
- [Documentation][documentation] - [Documentation][documentation]
- [Guide][guide] ([source][guide-source]) - [Guide][guide] ([source][guide-source])
See also the [Update Guide][guide-update], including updated and removed items in the library. Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
- [discord.js Discord server][discord] - [discord.js Discord server][discord]
- [Discord API Discord server][discord-api] - [Discord API Discord server][discord-api]
- [GitHub][source] - [GitHub][source]
@@ -88,12 +88,11 @@ See [the contribution guide][contributing] if you'd like to submit a PR.
## Help ## Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
[website]: https://discord.js.org/ [website]: https://discord.js.org
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
[documentation]: https://discord.js.org/#/docs/voice [documentation]: https://discord.js.org/docs/packages/voice/stable
[guide]: https://discordjs.guide/ [guide]: https://discordjs.guide/
[guide-source]: https://github.com/discordjs/guide [guide-source]: https://github.com/discordjs/guide
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html

9
packages/ws/README.md
View File

@@ -164,7 +164,7 @@ void bootstrapper.bootstrap({
- [Website][website] ([source][website-source]) - [Website][website] ([source][website-source])
- [Documentation][documentation] - [Documentation][documentation]
- [Guide][guide] ([source][guide-source]) - [Guide][guide] ([source][guide-source])
See also the [Update Guide][guide-update], including updated and removed items in the library. Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
- [discord.js Discord server][discord] - [discord.js Discord server][discord]
- [Discord API Discord server][discord-api] - [Discord API Discord server][discord-api]
- [GitHub][source] - [GitHub][source]
@@ -179,12 +179,11 @@ See [the contribution guide][contributing] if you'd like to submit a PR.
## Help ## Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
[website]: https://discord.js.org/ [website]: https://discord.js.org
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
[documentation]: https://discord.js.org/#/docs/ws [documentation]: https://discord.js.org/docs/packages/ws/stable
[guide]: https://discordjs.guide/ [guide]: https://discordjs.guide/
[guide-source]: https://github.com/discordjs/guide [guide-source]: https://github.com/discordjs/guide
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html