diff --git a/README.md b/README.md index 033afd0f7..97ec2f753 100644 --- a/README.md +++ b/README.md @@ -104,27 +104,42 @@ client.login('token'); ## Links -- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) -- [Documentation](https://discord.js.org/#/docs) -- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. -- [discord.js Discord server](https://discord.gg/djs) -- [Discord API Discord server](https://discord.gg/discord-api) -- [GitHub](https://github.com/discordjs/discord.js) -- [npm](https://www.npmjs.com/package/discord.js) -- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) +- [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. +- [discord.js Discord server][discord] +- [Discord API Discord server][discord-api] +- [GitHub][source] +- [npm][npm] +- [Related libraries][related-libs] ### Extensions -- [RPC](https://www.npmjs.com/package/discord-rpc) ([source](https://github.com/discordjs/RPC)) +- [RPC][rpc] ([source][rpc-source]) ## Contributing Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation](https://discord.js.org/#/docs). -See [the contribution guide](https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR. +[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](https://discord.gg/djs). +nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord]. + +[website]: https://discord.js.org/ +[website-source]: https://github.com/discordjs/discord.js/tree/main/packages/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 +[discord]: https://discord.gg/djs +[discord-api]: https://discord.gg/discord-api +[source]: https://github.com/discordjs/discord.js/tree/main/packages/discord.js +[npm]: https://www.npmjs.com/package/discord.js +[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries +[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 diff --git a/packages/actions/README.md b/packages/actions/README.md index 543c22ad1..1d0b30752 100644 --- a/packages/actions/README.md +++ b/packages/actions/README.md @@ -15,20 +15,32 @@ ## Links -- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) -- [Documentation](https://discord.js.org/#/docs) -- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. -- [discord.js Discord server](https://discord.gg/djs) -- [Discord API Discord server](https://discord.gg/discord-api) -- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/scripts) -- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) +- [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. +- [discord.js Discord server][discord] +- [Discord API Discord server][discord-api] +- [GitHub][source] +- [Related libraries][related-libs] ## Contributing -See [the contribution guide](https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR. +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](https://discord.gg/djs). +nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord]. + +[website]: https://discord.js.org/ +[website-source]: https://github.com/discordjs/discord.js/tree/main/packages/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 +[discord]: https://discord.gg/djs +[discord-api]: https://discord.gg/discord-api +[source]: https://github.com/discordjs/discord.js/tree/main/packages/actions +[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries +[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md diff --git a/packages/api-extractor-utils/README.md b/packages/api-extractor-utils/README.md index 543c22ad1..5db53fc29 100644 --- a/packages/api-extractor-utils/README.md +++ b/packages/api-extractor-utils/README.md @@ -15,20 +15,32 @@ ## Links -- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) -- [Documentation](https://discord.js.org/#/docs) -- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. -- [discord.js Discord server](https://discord.gg/djs) -- [Discord API Discord server](https://discord.gg/discord-api) -- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/scripts) -- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) +- [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. +- [discord.js Discord server][discord] +- [Discord API Discord server][discord-api] +- [GitHub][source] +- [Related libraries][related-libs] ## Contributing -See [the contribution guide](https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR. +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](https://discord.gg/djs). +nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord]. + +[website]: https://discord.js.org/ +[website-source]: https://github.com/discordjs/discord.js/tree/main/packages/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 +[discord]: https://discord.gg/djs +[discord-api]: https://discord.gg/discord-api +[source]: https://github.com/discordjs/discord.js/tree/main/packages/api-extractor-utils +[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries +[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md diff --git a/packages/builders/README.md b/packages/builders/README.md index 23b5cb727..74523801b 100644 --- a/packages/builders/README.md +++ b/packages/builders/README.md @@ -30,27 +30,41 @@ pnpm add @discordjs/builders Here are some examples for the builders and utilities you can find in this package: -- [Slash Command Builders](https://github.com/discordjs/discord.js/blob/main/packages/builders/docs/examples/Slash%20Command%20Builders.md) +- [Slash Command Builders][example] ## Links -- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) -- [Documentation](https://discord.js.org/#/docs/builders) -- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. -- [discord.js Discord server](https://discord.gg/djs) -- [Discord API Discord server](https://discord.gg/discord-api) -- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/builders) -- [npm](https://www.npmjs.com/package/@discordjs/builders) -- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) +- [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. +- [discord.js Discord server][discord] +- [Discord API Discord server][discord-api] +- [GitHub][source] +- [npm][npm] +- [Related libraries][related-libs] ## Contributing Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation](https://discord.js.org/#/docs/builders). -See [the contribution guide](https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR. +[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](https://discord.gg/djs). +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-source]: https://github.com/discordjs/discord.js/tree/main/packages/website +[documentation]: https://discord.js.org/#/docs/builders +[guide]: https://discordjs.guide/ +[guide-source]: https://github.com/discordjs/guide +[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html +[discord]: https://discord.gg/djs +[discord-api]: https://discord.gg/discord-api +[source]: https://github.com/discordjs/discord.js/tree/main/packages/builders +[npm]: https://www.npmjs.com/package/@discordjs/builders +[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries +[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md diff --git a/packages/collection/README.md b/packages/collection/README.md index b036f1c48..c3effb95a 100644 --- a/packages/collection/README.md +++ b/packages/collection/README.md @@ -32,23 +32,36 @@ pnpm add @discordjs/collection ## Links -- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) -- [Documentation](https://discord.js.org/#/docs/collection) -- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. -- [discord.js Discord server](https://discord.gg/djs) -- [Discord API Discord server](https://discord.gg/discord-api) -- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/collection) -- [npm](https://www.npmjs.com/package/@discordjs/collection) -- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) +- [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. +- [discord.js Discord server][discord] +- [Discord API Discord server][discord-api] +- [GitHub][source] +- [npm][npm] +- [Related libraries][related-libs] ## Contributing Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation](https://discord.js.org/#/docs/collection). -See [the contribution guide](https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR. +[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](https://discord.gg/djs). +nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord]. + +[website]: https://discord.js.org/ +[website-source]: https://github.com/discordjs/discord.js/tree/main/packages/website +[documentation]: https://discord.js.org/#/docs/collection +[guide]: https://discordjs.guide/ +[guide-source]: https://github.com/discordjs/guide +[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html +[discord]: https://discord.gg/djs +[discord-api]: https://discord.gg/discord-api +[source]: https://github.com/discordjs/discord.js/tree/main/packages/collection +[npm]: https://www.npmjs.com/package/@discordjs/collection +[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries +[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md diff --git a/packages/discord.js/README.md b/packages/discord.js/README.md index dd196a1ef..23bdecc0f 100644 --- a/packages/discord.js/README.md +++ b/packages/discord.js/README.md @@ -9,6 +9,7 @@ npm version npm downloads Tests status + Code coverage

Vercel @@ -103,27 +104,42 @@ client.login('token'); ## Links -- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) -- [Documentation](https://discord.js.org/#/docs) -- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. -- [discord.js Discord server](https://discord.gg/djs) -- [Discord API Discord server](https://discord.gg/discord-api) -- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/discord.js) -- [npm](https://www.npmjs.com/package/discord.js) -- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) +- [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. +- [discord.js Discord server][discord] +- [Discord API Discord server][discord-api] +- [GitHub][source] +- [npm][npm] +- [Related libraries][related-libs] ### Extensions -- [RPC](https://www.npmjs.com/package/discord-rpc) ([source](https://github.com/discordjs/RPC)) +- [RPC][rpc] ([source][rpc-source]) ## Contributing Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation](https://discord.js.org/#/docs). -See [the contribution guide](https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR. +[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](https://discord.gg/djs). +nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord]. + +[website]: https://discord.js.org/ +[website-source]: https://github.com/discordjs/discord.js/tree/main/packages/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 +[discord]: https://discord.gg/djs +[discord-api]: https://discord.gg/discord-api +[source]: https://github.com/discordjs/discord.js/tree/main/packages/discord.js +[npm]: https://www.npmjs.com/package/discord.js +[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries +[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 diff --git a/packages/docgen/README.md b/packages/docgen/README.md index 543c22ad1..5ad34778d 100644 --- a/packages/docgen/README.md +++ b/packages/docgen/README.md @@ -15,20 +15,34 @@ ## Links -- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) -- [Documentation](https://discord.js.org/#/docs) -- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. -- [discord.js Discord server](https://discord.gg/djs) -- [Discord API Discord server](https://discord.gg/discord-api) -- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/scripts) -- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) +- [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. +- [discord.js Discord server][discord] +- [Discord API Discord server][discord-api] +- [GitHub][source] +- [npm][npm] +- [Related libraries][related-libs] ## Contributing -See [the contribution guide](https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR. +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](https://discord.gg/djs). +nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord]. + +[website]: https://discord.js.org/ +[website-source]: https://github.com/discordjs/discord.js/tree/main/packages/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 +[discord]: https://discord.gg/djs +[discord-api]: https://discord.gg/discord-api +[source]: https://github.com/discordjs/discord.js/tree/main/packages/docgen +[npm]: https://www.npmjs.com/package/@discordjs/docgen +[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries +[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md diff --git a/packages/guide/README.md b/packages/guide/README.md new file mode 100644 index 000000000..734d870a7 --- /dev/null +++ b/packages/guide/README.md @@ -0,0 +1,46 @@ +

+
+

+ discord.js +

+
+

+ Discord server + Build status +

+

+ Vercel +

+
+ +## 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. +- [discord.js Discord server][discord] +- [Discord API Discord server][discord-api] +- [GitHub][source] +- [Related libraries][related-libs] + +## Contributing + +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]. + +[website]: https://discord.js.org/ +[website-source]: https://github.com/discordjs/discord.js/tree/main/packages/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 +[discord]: https://discord.gg/djs +[discord-api]: https://discord.gg/discord-api +[source]: https://github.com/discordjs/discord.js/tree/main/packages/guide +[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries +[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md diff --git a/packages/proxy-container/README.md b/packages/proxy-container/README.md index 9eeae0749..0fd0beb88 100644 --- a/packages/proxy-container/README.md +++ b/packages/proxy-container/README.md @@ -50,17 +50,32 @@ const rest = new REST({ ## Links -- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/website)) -- [discord.js Discord server](https://discord.gg/djs) -- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/proxy-container) -- [Docker Hub](https://hub.docker.com/r/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. +- [discord.js Discord server][discord] +- [Discord API Discord server][discord-api] +- [GitHub][source] +- [Related libraries][related-libs] ## Contributing -Before creating an issue, please ensure that it hasn't already been reported/suggested. -See [the contribution guide](https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR. +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](https://discord.gg/djs). +nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord]. + +[website]: https://discord.js.org/ +[website-source]: https://github.com/discordjs/discord.js/tree/main/packages/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 +[discord]: https://discord.gg/djs +[discord-api]: https://discord.gg/discord-api +[source]: https://github.com/discordjs/discord.js/tree/main/packages/proxy-container +[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries +[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md diff --git a/packages/proxy/README.md b/packages/proxy/README.md index 4799a9e09..8b3567716 100644 --- a/packages/proxy/README.md +++ b/packages/proxy/README.md @@ -32,23 +32,36 @@ pnpm add @discordjs/proxy ## Links -- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) -- [Documentation](https://discord.js.org/#/docs/proxy) -- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. -- [discord.js Discord server](https://discord.gg/djs) -- [Discord API Discord server](https://discord.gg/discord-api) -- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/proxy) -- [npm](https://www.npmjs.com/package/@discordjs/proxy) -- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) +- [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. +- [discord.js Discord server][discord] +- [Discord API Discord server][discord-api] +- [GitHub][source] +- [npm][npm] +- [Related libraries][related-libs] ## Contributing Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation](https://discord.js.org/#/docs/proxy). -See [the contribution guide](https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR. +[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](https://discord.gg/djs). +nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord]. + +[website]: https://discord.js.org/ +[website-source]: https://github.com/discordjs/discord.js/tree/main/packages/website +[documentation]: https://discord.js.org/#/docs/proxy +[guide]: https://discordjs.guide/ +[guide-source]: https://github.com/discordjs/guide +[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html +[discord]: https://discord.gg/djs +[discord-api]: https://discord.gg/discord-api +[source]: https://github.com/discordjs/discord.js/tree/main/packages/proxy +[npm]: https://www.npmjs.com/package/@discordjs/proxy +[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries +[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md diff --git a/packages/rest/README.md b/packages/rest/README.md index c20c1eff0..90504da17 100644 --- a/packages/rest/README.md +++ b/packages/rest/README.md @@ -77,22 +77,36 @@ try { ## Links -- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) -- [Documentation](https://discord.js.org/#/docs/rest) -- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. -- [discord.js Discord server](https://discord.gg/djs) -- [Discord API Discord server](https://discord.gg/discord-api) -- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/rest) -- [npm](https://www.npmjs.com/package/@discordjs/rest) -- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) +- [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. +- [discord.js Discord server][discord] +- [Discord API Discord server][discord-api] +- [GitHub][source] +- [npm][npm] +- [Related libraries][related-libs] ## Contributing Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation](https://discord.js.org/#/docs/rest). -See [the contribution guide](https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR. +[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](https://discord.gg/djs). +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-source]: https://github.com/discordjs/discord.js/tree/main/packages/website +[documentation]: https://discord.js.org/#/docs/rest +[guide]: https://discordjs.guide/ +[guide-source]: https://github.com/discordjs/guide +[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html +[discord]: https://discord.gg/djs +[discord-api]: https://discord.gg/discord-api +[source]: https://github.com/discordjs/discord.js/tree/main/packages/rest +[npm]: https://www.npmjs.com/package/@discordjs/rest +[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries +[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md diff --git a/packages/scripts/README.md b/packages/scripts/README.md index 543c22ad1..79ef90b97 100644 --- a/packages/scripts/README.md +++ b/packages/scripts/README.md @@ -15,20 +15,32 @@ ## Links -- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) -- [Documentation](https://discord.js.org/#/docs) -- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. -- [discord.js Discord server](https://discord.gg/djs) -- [Discord API Discord server](https://discord.gg/discord-api) -- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/scripts) -- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) +- [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. +- [discord.js Discord server][discord] +- [Discord API Discord server][discord-api] +- [GitHub][source] +- [Related libraries][related-libs] ## Contributing -See [the contribution guide](https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR. +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](https://discord.gg/djs). +nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord]. + +[website]: https://discord.js.org/ +[website-source]: https://github.com/discordjs/discord.js/tree/main/packages/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 +[discord]: https://discord.gg/djs +[discord-api]: https://discord.gg/discord-api +[source]: https://github.com/discordjs/discord.js/tree/main/packages/scripts +[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries +[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md diff --git a/packages/ui/README.md b/packages/ui/README.md new file mode 100644 index 000000000..ae1d699fd --- /dev/null +++ b/packages/ui/README.md @@ -0,0 +1,46 @@ +
+
+

+ discord.js +

+
+

+ Discord server + Build status +

+

+ Vercel +

+
+ +## 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. +- [discord.js Discord server][discord] +- [Discord API Discord server][discord-api] +- [GitHub][source] +- [Related libraries][related-libs] + +## Contributing + +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]. + +[website]: https://discord.js.org/ +[website-source]: https://github.com/discordjs/discord.js/tree/main/packages/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 +[discord]: https://discord.gg/djs +[discord-api]: https://discord.gg/discord-api +[source]: https://github.com/discordjs/discord.js/tree/main/packages/ui +[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries +[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md diff --git a/packages/util/README.md b/packages/util/README.md index 543c22ad1..e8e30fb0e 100644 --- a/packages/util/README.md +++ b/packages/util/README.md @@ -13,22 +13,48 @@

+## Installation + +**Node.js 16.9.0 or newer is required.** + +```sh-session +npm install @discordjs/util +yarn add @discordjs/util +pnpm add @discordjs/util +``` + ## Links -- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) -- [Documentation](https://discord.js.org/#/docs) -- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. -- [discord.js Discord server](https://discord.gg/djs) -- [Discord API Discord server](https://discord.gg/discord-api) -- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/scripts) -- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) +- [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. +- [discord.js Discord server][discord] +- [Discord API Discord server][discord-api] +- [GitHub][source] +- [npm][npm] +- [Related libraries][related-libs] ## Contributing -See [the contribution guide](https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR. +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](https://discord.gg/djs). +nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord]. + +[website]: https://discord.js.org/ +[website-source]: https://github.com/discordjs/discord.js/tree/main/packages/website +[documentation]: https://discord.js.org/#/docs/util +[guide]: https://discordjs.guide/ +[guide-source]: https://github.com/discordjs/guide +[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html +[discord]: https://discord.gg/djs +[discord-api]: https://discord.gg/discord-api +[source]: https://github.com/discordjs/discord.js/tree/main/packages/util +[npm]: https://www.npmjs.com/package/@discordjs/util +[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries +[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md diff --git a/packages/voice/README.md b/packages/voice/README.md index 3de2a714d..ec1b57b39 100644 --- a/packages/voice/README.md +++ b/packages/voice/README.md @@ -66,24 +66,36 @@ try installing another. ## Links -- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) -- [Documentation](https://discord.js.org/#/docs/voice) -- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. -- [discord.js Discord server](https://discord.gg/djs) -- [Discord API Discord server](https://discord.gg/discord-api) -- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/voice) -- [npm](https://www.npmjs.com/package/@discordjs/voice) -- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) -- [Examples](https://github.com/discordjs/discord.js/tree/main/packages/voice/examples) +- [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. +- [discord.js Discord server][discord] +- [Discord API Discord server][discord-api] +- [GitHub][source] +- [npm][npm] +- [Related libraries][related-libs] ## Contributing Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation](https://discord.js.org/#/docs/voice). -See [the contribution guide](https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR. +[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](https://discord.gg/djs). +nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord]. + +[website]: https://discord.js.org/ +[website-source]: https://github.com/discordjs/discord.js/tree/main/packages/website +[documentation]: https://discord.js.org/#/docs/voice +[guide]: https://discordjs.guide/ +[guide-source]: https://github.com/discordjs/guide +[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html +[discord]: https://discord.gg/djs +[discord-api]: https://discord.gg/discord-api +[source]: https://github.com/discordjs/discord.js/tree/main/packages/voice +[npm]: https://www.npmjs.com/package/@discordjs/voice +[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries +[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md diff --git a/packages/website/README.md b/packages/website/README.md index 7cd427a5c..273f04ba7 100644 --- a/packages/website/README.md +++ b/packages/website/README.md @@ -15,22 +15,32 @@ ## Links -- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) -- [Documentation](https://discord.js.org/#/docs) -- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. -- [discord.js Discord server](https://discord.gg/djs) -- [Discord API Discord server](https://discord.gg/discord-api) -- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/website) -- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) +- [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. +- [discord.js Discord server][discord] +- [Discord API Discord server][discord-api] +- [GitHub][source] +- [Related libraries][related-libs] ## Contributing -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation](https://discord.js.org/#/docs/builders). -See [the contribution guide](https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR. +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](https://discord.gg/djs). +nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord]. + +[website]: https://discord.js.org/ +[website-source]: https://github.com/discordjs/discord.js/tree/main/packages/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 +[discord]: https://discord.gg/djs +[discord-api]: https://discord.gg/discord-api +[source]: https://github.com/discordjs/discord.js/tree/main/packages/website +[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries +[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md diff --git a/packages/ws/README.md b/packages/ws/README.md index a898808ed..3118ebd21 100644 --- a/packages/ws/README.md +++ b/packages/ws/README.md @@ -105,23 +105,36 @@ manager.setStrategy(new WorkerShardingStrategy(manager, { shardsPerWorker: 'all' ## Links -- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) -- [Documentation](https://discord.js.org/#/docs/ws) -- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. -- [discord.js Discord server](https://discord.gg/djs) -- [Discord API Discord server](https://discord.gg/discord-api) -- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/ws) -- [npm](https://www.npmjs.com/package/@discordjs/ws) -- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) +- [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. +- [discord.js Discord server][discord] +- [Discord API Discord server][discord-api] +- [GitHub][source] +- [npm][npm] +- [Related libraries][related-libs] ## Contributing Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation](https://discord.js.org/#/docs/ws). -See [the contribution guide](https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR. +[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](https://discord.gg/djs). +nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord]. + +[website]: https://discord.js.org/ +[website-source]: https://github.com/discordjs/discord.js/tree/main/packages/website +[documentation]: https://discord.js.org/#/docs/ws +[guide]: https://discordjs.guide/ +[guide-source]: https://github.com/discordjs/guide +[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html +[discord]: https://discord.gg/djs +[discord-api]: https://discord.gg/discord-api +[source]: https://github.com/discordjs/discord.js/tree/main/packages/ws +[npm]: https://www.npmjs.com/package/@discordjs/ws +[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries +[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md