diff --git a/README.md b/README.md index 49ae2b376..6a90158c4 100644 --- a/README.md +++ b/README.md @@ -18,96 +18,28 @@ ## About -discord.js is a powerful [Node.js](https://nodejs.org) module that allows you to easily interact with the -[Discord API](https://discord.com/developers/docs/intro). +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). -- Object-oriented -- Predictable abstractions -- Performant -- 100% coverage of the Discord API +## Packages -## Installation - -**Node.js 16.9.0 or newer is required.** - -```sh -npm install discord.js -yarn add discord.js -pnpm add discord.js -``` - -### Optional packages - -- [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); -``` +- `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 +- `@discordjs/builders` ([source][builders-source]) - A utility package for easily building Discord API payloads +- `@discordjs/collection` ([source][collection-source]) - A powerful utility data structure +- `@discordjs/core` ([source][core-source]) - A thinly abstracted wrapper around the core components of the Discord API +- `@discordjs/formatters` ([source][formatters-source]) - A collection of functions for formatting strings +- `@discordjs/proxy` ([source][proxy-source]) - A wrapper around `@discordjs/rest` for running an HTTP proxy +- `@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 +- `@discordjs/ws` ([source][ws-source]) - A wrapper around Discord's gateway ## Links - [Website][website] ([source][website-source]) - [Documentation][documentation] - [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 API Discord server][discord-api] - [GitHub][source] @@ -120,18 +52,15 @@ client.login(TOKEN); ## 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. +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. ## Help -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 join our [Discord server][discord]. -[website]: https://discord.js.org/ +[website]: https://discord.js.org [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-source]: https://github.com/discordjs/guide [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-source]: https://github.com/discordjs/RPC [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 diff --git a/apps/guide/README.md b/apps/guide/README.md index 94ac3db00..2a6eddca4 100644 --- a/apps/guide/README.md +++ b/apps/guide/README.md @@ -13,12 +13,16 @@

+## About + +The official guide for discord.js, made to help you get started easily with the library. + ## Links - [Website][website] ([source][website-source]) - [Documentation][documentation] - [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 API Discord server][discord-api] - [GitHub][source] @@ -26,16 +30,17 @@ ## 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. ## Help -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 -[documentation]: https://discord.js.org/ +[documentation]: https://discord.js.org/docs [guide]: https://discordjs.guide/ [guide-source]: https://github.com/discordjs/guide [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html diff --git a/apps/website/README.md b/apps/website/README.md index ca3e929fc..5c1417fc3 100644 --- a/apps/website/README.md +++ b/apps/website/README.md @@ -18,7 +18,7 @@ - [Website][website] ([source][website-source]) - [Documentation][documentation] - [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 API Discord server][discord-api] - [GitHub][source] @@ -26,16 +26,17 @@ ## 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. ## Help -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 -[documentation]: https://discord.js.org/ +[documentation]: https://discord.js.org/docs [guide]: https://discordjs.guide/ [guide-source]: https://github.com/discordjs/guide [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html diff --git a/packages/actions/README.md b/packages/actions/README.md index ea818daad..305c36ba7 100644 --- a/packages/actions/README.md +++ b/packages/actions/README.md @@ -16,9 +16,8 @@ ## Links - [Website][website] ([source][website-source]) -- [Documentation][documentation] - [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 API Discord server][discord-api] - [GitHub][source] @@ -26,16 +25,16 @@ ## 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. ## Help -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 -[documentation]: https://discord.js.org/#/docs [guide]: https://discordjs.guide/ [guide-source]: https://github.com/discordjs/guide [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html diff --git a/packages/api-extractor-utils/README.md b/packages/api-extractor-utils/README.md index 4861c268b..9309ac270 100644 --- a/packages/api-extractor-utils/README.md +++ b/packages/api-extractor-utils/README.md @@ -16,9 +16,8 @@ ## Links - [Website][website] ([source][website-source]) -- [Documentation][documentation] - [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 API Discord server][discord-api] - [GitHub][source] @@ -26,16 +25,16 @@ ## 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. ## Help -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 -[documentation]: https://discord.js.org/#/docs [guide]: https://discordjs.guide/ [guide-source]: https://github.com/discordjs/guide [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html diff --git a/packages/brokers/README.md b/packages/brokers/README.md index b29377ddf..dabd22047 100644 --- a/packages/brokers/README.md +++ b/packages/brokers/README.md @@ -88,7 +88,7 @@ await broker.subscribe('responders', ['testcall']); - [Website][website] ([source][website-source]) - [Documentation][documentation] - [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 API Discord server][discord-api] - [GitHub][source] @@ -103,12 +103,11 @@ See [the contribution guide][contributing] if you'd like to submit a PR. ## Help -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 -[documentation]: https://discord.js.org/#/docs/brokers +[documentation]: https://discord.js.org/docs/packages/brokers/stable [guide]: https://discordjs.guide/ [guide-source]: https://github.com/discordjs/guide [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html diff --git a/packages/builders/README.md b/packages/builders/README.md index 66f6d8bc3..518424250 100644 --- a/packages/builders/README.md +++ b/packages/builders/README.md @@ -16,6 +16,10 @@

+## About + +`@discord.js/builders` is a utility package for easily building Discord API payloads. + ## Installation **Node.js 16.9.0 or newer is required.** @@ -28,16 +32,14 @@ pnpm add @discordjs/builders ## Examples -Here are some examples for the builders and utilities you can find in this package: - -- [Slash Command Builders][example] +You can find examples of how to use the builders in the [Slash Command Builders][example] examples. ## Links - [Website][website] ([source][website-source]) - [Documentation][documentation] - [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 API Discord server][discord-api] - [GitHub][source] @@ -52,13 +54,12 @@ See [the contribution guide][contributing] if you'd like to submit a PR. ## Help -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]. [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 -[documentation]: https://discord.js.org/#/docs/builders +[documentation]: https://discord.js.org/docs/packages/builders/stable [guide]: https://discordjs.guide/ [guide-source]: https://github.com/discordjs/guide [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html diff --git a/packages/collection/README.md b/packages/collection/README.md index 879c96cd9..3e7b3693d 100644 --- a/packages/collection/README.md +++ b/packages/collection/README.md @@ -35,7 +35,7 @@ pnpm add @discordjs/collection - [Website][website] ([source][website-source]) - [Documentation][documentation] - [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 API Discord server][discord-api] - [GitHub][source] @@ -50,12 +50,11 @@ See [the contribution guide][contributing] if you'd like to submit a PR. ## Help -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 -[documentation]: https://discord.js.org/#/docs/collection +[documentation]: https://discord.js.org/docs/packages/collection/stable [guide]: https://discordjs.guide/ [guide-source]: https://github.com/discordjs/guide [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html diff --git a/packages/core/README.md b/packages/core/README.md index 8c6f34793..506ac8b8a 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -83,7 +83,7 @@ const guild = await api.guilds.get('1234567891011'); - [Website][website] ([source][website-source]) - [Documentation][documentation] - [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 API Discord server][discord-api] - [GitHub][source] @@ -98,12 +98,11 @@ See [the contribution guide][contributing] if you'd like to submit a PR. ## Help -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 -[documentation]: https://discord.js.org/ +[documentation]: https://discord.js.org/docs/packages/core/stable [guide]: https://discordjs.guide/ [guide-source]: https://github.com/discordjs/guide [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html diff --git a/packages/discord.js/README.md b/packages/discord.js/README.md index 79f34c0e6..18ce3adf3 100644 --- a/packages/discord.js/README.md +++ b/packages/discord.js/README.md @@ -107,7 +107,7 @@ client.login(TOKEN); - [Website][website] ([source][website-source]) - [Documentation][documentation] - [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 API Discord server][discord-api] - [GitHub][source] @@ -126,12 +126,11 @@ See [the contribution guide][contributing] if you'd like to submit a PR. ## Help -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 -[documentation]: https://discord.js.org/#/docs +[documentation]: https://discord.js.org/docs/packages/discord.js/stable [guide]: https://discordjs.guide/ [guide-source]: https://github.com/discordjs/guide [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html diff --git a/packages/docgen/README.md b/packages/docgen/README.md index ca28fa9ec..fab95f796 100644 --- a/packages/docgen/README.md +++ b/packages/docgen/README.md @@ -18,7 +18,7 @@ - [Website][website] ([source][website-source]) - [Documentation][documentation] - [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 API Discord server][discord-api] - [GitHub][source] @@ -27,16 +27,16 @@ ## 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. ## Help -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 -[documentation]: https://discord.js.org/ [guide]: https://discordjs.guide/ [guide-source]: https://github.com/discordjs/guide [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html diff --git a/packages/formatters/README.md b/packages/formatters/README.md index ee8906748..92798d6bd 100644 --- a/packages/formatters/README.md +++ b/packages/formatters/README.md @@ -18,7 +18,7 @@ ## 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 @@ -49,7 +49,7 @@ console.log(formattedCode); - [Website][website] ([source][website-source]) - [Documentation][documentation] - [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 API Discord server][discord-api] - [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]. -[website]: https://discord.js.org/ +[website]: https://discord.js.org [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-source]: https://github.com/discordjs/guide [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html diff --git a/packages/next/README.md b/packages/next/README.md index d6a096710..8dfb80941 100644 --- a/packages/next/README.md +++ b/packages/next/README.md @@ -26,9 +26,8 @@ pnpm add @discordjs/next ## Links - [Website][website] ([source][website-source]) -- [Documentation][documentation] - [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 API Discord server][discord-api] - [GitHub][source] @@ -43,12 +42,11 @@ See [the contribution guide][contributing] if you'd like to submit a PR. ## Help -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 -[documentation]: https://discord.js.org/#/docs/next +[documentation]: https://discord.js.org/docs/packages/next/stable [guide]: https://discordjs.guide/ [guide-source]: https://github.com/discordjs/guide [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html diff --git a/packages/proxy-container/README.md b/packages/proxy-container/README.md index 825f04228..b499fb418 100644 --- a/packages/proxy-container/README.md +++ b/packages/proxy-container/README.md @@ -53,7 +53,7 @@ const rest = new REST({ - [Website][website] ([source][website-source]) - [Documentation][documentation] - [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 API Discord server][discord-api] - [GitHub][source] @@ -61,16 +61,16 @@ const rest = new REST({ ## 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. ## Help -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 -[documentation]: https://discord.js.org/ [guide]: https://discordjs.guide/ [guide-source]: https://github.com/discordjs/guide [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html diff --git a/packages/proxy/README.md b/packages/proxy/README.md index 765d507c1..c29ef8cb6 100644 --- a/packages/proxy/README.md +++ b/packages/proxy/README.md @@ -18,7 +18,7 @@ ## 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 @@ -35,7 +35,7 @@ pnpm add @discordjs/proxy - [Website][website] ([source][website-source]) - [Documentation][documentation] - [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 API Discord server][discord-api] - [GitHub][source] @@ -50,12 +50,11 @@ See [the contribution guide][contributing] if you'd like to submit a PR. ## Help -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 -[documentation]: https://discord.js.org/#/docs/proxy +[documentation]: https://discord.js.org/docs/packages/proxy/stable [guide]: https://discordjs.guide/ [guide-source]: https://github.com/discordjs/guide [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html diff --git a/packages/rest/README.md b/packages/rest/README.md index d50159ba1..f4c32831e 100644 --- a/packages/rest/README.md +++ b/packages/rest/README.md @@ -16,6 +16,10 @@

+## About + +`@discord.js/rest` is a module that allows you to easily make REST requests to the Discord API. + ## Installation **Node.js 16.9.0 or newer is required.** @@ -80,7 +84,7 @@ try { - [Website][website] ([source][website-source]) - [Documentation][documentation] - [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 API Discord server][discord-api] - [GitHub][source] @@ -95,12 +99,11 @@ See [the contribution guide][contributing] if you'd like to submit a PR. ## Help -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 -[documentation]: https://discord.js.org/#/docs/rest +[documentation]: https://discord.js.org/docs/packages/rest/stable [guide]: https://discordjs.guide/ [guide-source]: https://github.com/discordjs/guide [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html diff --git a/packages/scripts/README.md b/packages/scripts/README.md index fe008a45a..7424ce61d 100644 --- a/packages/scripts/README.md +++ b/packages/scripts/README.md @@ -16,9 +16,8 @@ ## Links - [Website][website] ([source][website-source]) -- [Documentation][documentation] - [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 API Discord server][discord-api] - [GitHub][source] @@ -26,16 +25,15 @@ ## 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. ## Help -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 -[documentation]: https://discord.js.org/#/docs/scripts [guide]: https://discordjs.guide/ [guide-source]: https://github.com/discordjs/guide [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html diff --git a/packages/ui/README.md b/packages/ui/README.md index 7757b5951..af164ca7f 100644 --- a/packages/ui/README.md +++ b/packages/ui/README.md @@ -18,7 +18,7 @@ - [Website][website] ([source][website-source]) - [Documentation][documentation] - [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 API Discord server][discord-api] - [GitHub][source] @@ -26,16 +26,16 @@ ## 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. ## Help -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 -[documentation]: https://discord.js.org/ [guide]: https://discordjs.guide/ [guide-source]: https://github.com/discordjs/guide [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html diff --git a/packages/util/README.md b/packages/util/README.md index 5177661d9..edd628d65 100644 --- a/packages/util/README.md +++ b/packages/util/README.md @@ -13,6 +13,10 @@

+## About + +`@discordjs/util` is a collection of utility functions for use with discord.js. + ## Installation **Node.js 16.9.0 or newer is required.** @@ -28,7 +32,7 @@ pnpm add @discordjs/util - [Website][website] ([source][website-source]) - [Documentation][documentation] - [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 API Discord server][discord-api] - [GitHub][source] @@ -43,12 +47,11 @@ See [the contribution guide][contributing] if you'd like to submit a PR. ## Help -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 -[documentation]: https://discord.js.org/#/docs/util +[documentation]: https://discord.js.org/docs/packages/util/stable [guide]: https://discordjs.guide/ [guide-source]: https://github.com/discordjs/guide [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html diff --git a/packages/voice/README.md b/packages/voice/README.md index 6bf19df8c..05d57f88b 100644 --- a/packages/voice/README.md +++ b/packages/voice/README.md @@ -18,7 +18,7 @@ ## 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:** @@ -73,7 +73,7 @@ The [voice-examples][voice-examples] repository contains examples on how to use - [Website][website] ([source][website-source]) - [Documentation][documentation] - [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 API Discord server][discord-api] - [GitHub][source] @@ -88,12 +88,11 @@ See [the contribution guide][contributing] if you'd like to submit a PR. ## Help -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 -[documentation]: https://discord.js.org/#/docs/voice +[documentation]: https://discord.js.org/docs/packages/voice/stable [guide]: https://discordjs.guide/ [guide-source]: https://github.com/discordjs/guide [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html diff --git a/packages/ws/README.md b/packages/ws/README.md index ca994d9e2..149a4713b 100644 --- a/packages/ws/README.md +++ b/packages/ws/README.md @@ -164,7 +164,7 @@ void bootstrapper.bootstrap({ - [Website][website] ([source][website-source]) - [Documentation][documentation] - [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 API Discord server][discord-api] - [GitHub][source] @@ -179,12 +179,11 @@ See [the contribution guide][contributing] if you'd like to submit a PR. ## Help -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 -[documentation]: https://discord.js.org/#/docs/ws +[documentation]: https://discord.js.org/docs/packages/ws/stable [guide]: https://discordjs.guide/ [guide-source]: https://github.com/discordjs/guide [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html