chore: update readmes

This commit is contained in:
iCrawl
2022-10-08 17:55:01 +02:00
parent 3f006cd33c
commit 87ec3922a3
17 changed files with 472 additions and 169 deletions

View File

@@ -104,27 +104,42 @@ client.login('token');
## Links ## Links
- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) - [Website][website] ([source][website-source])
- [Documentation](https://discord.js.org/#/docs) - [Documentation][documentation]
- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - [Guide][guide] ([source][guide-source])
See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. See also the [Update Guide][guide-update], including updated and removed items in the library.
- [discord.js Discord server](https://discord.gg/djs) - [discord.js Discord server][discord]
- [Discord API Discord server](https://discord.gg/discord-api) - [Discord API Discord server][discord-api]
- [GitHub](https://github.com/discordjs/discord.js) - [GitHub][source]
- [npm](https://www.npmjs.com/package/discord.js) - [npm][npm]
- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) - [Related libraries][related-libs]
### Extensions ### Extensions
- [RPC](https://www.npmjs.com/package/discord-rpc) ([source](https://github.com/discordjs/RPC)) - [RPC][rpc] ([source][rpc-source])
## Contributing ## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
[documentation](https://discord.js.org/#/docs). [documentation][documentation].
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 ## 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](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

View File

@@ -15,20 +15,32 @@
## Links ## Links
- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) - [Website][website] ([source][website-source])
- [Documentation](https://discord.js.org/#/docs) - [Documentation][documentation]
- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - [Guide][guide] ([source][guide-source])
See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. See also the [Update Guide][guide-update], including updated and removed items in the library.
- [discord.js Discord server](https://discord.gg/djs) - [discord.js Discord server][discord]
- [Discord API Discord server](https://discord.gg/discord-api) - [Discord API Discord server][discord-api]
- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/scripts) - [GitHub][source]
- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) - [Related libraries][related-libs]
## Contributing ## 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 ## 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](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

View File

@@ -15,20 +15,32 @@
## Links ## Links
- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) - [Website][website] ([source][website-source])
- [Documentation](https://discord.js.org/#/docs) - [Documentation][documentation]
- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - [Guide][guide] ([source][guide-source])
See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. See also the [Update Guide][guide-update], including updated and removed items in the library.
- [discord.js Discord server](https://discord.gg/djs) - [discord.js Discord server][discord]
- [Discord API Discord server](https://discord.gg/discord-api) - [Discord API Discord server][discord-api]
- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/scripts) - [GitHub][source]
- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) - [Related libraries][related-libs]
## Contributing ## 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 ## 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](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

View File

@@ -30,27 +30,41 @@ pnpm add @discordjs/builders
Here are some examples for the builders and utilities you can find in this package: 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 ## Links
- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) - [Website][website] ([source][website-source])
- [Documentation](https://discord.js.org/#/docs/builders) - [Documentation][documentation]
- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - [Guide][guide] ([source][guide-source])
See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. See also the [Update Guide][guide-update], including updated and removed items in the library.
- [discord.js Discord server](https://discord.gg/djs) - [discord.js Discord server][discord]
- [Discord API Discord server](https://discord.gg/discord-api) - [Discord API Discord server][discord-api]
- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/builders) - [GitHub][source]
- [npm](https://www.npmjs.com/package/@discordjs/builders) - [npm][npm]
- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) - [Related libraries][related-libs]
## Contributing ## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the 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). [documentation][documentation].
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 ## 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](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

View File

@@ -32,23 +32,36 @@ pnpm add @discordjs/collection
## Links ## Links
- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) - [Website][website] ([source][website-source])
- [Documentation](https://discord.js.org/#/docs/collection) - [Documentation][documentation]
- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - [Guide][guide] ([source][guide-source])
See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. See also the [Update Guide][guide-update], including updated and removed items in the library.
- [discord.js Discord server](https://discord.gg/djs) - [discord.js Discord server][discord]
- [Discord API Discord server](https://discord.gg/discord-api) - [Discord API Discord server][discord-api]
- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/collection) - [GitHub][source]
- [npm](https://www.npmjs.com/package/@discordjs/collection) - [npm][npm]
- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) - [Related libraries][related-libs]
## Contributing ## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the 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). [documentation][documentation].
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 ## 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](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

View File

@@ -9,6 +9,7 @@
<a href="https://www.npmjs.com/package/discord.js"><img src="https://img.shields.io/npm/v/discord.js.svg?maxAge=3600" alt="npm version" /></a> <a href="https://www.npmjs.com/package/discord.js"><img src="https://img.shields.io/npm/v/discord.js.svg?maxAge=3600" alt="npm version" /></a>
<a href="https://www.npmjs.com/package/discord.js"><img src="https://img.shields.io/npm/dt/discord.js.svg?maxAge=3600" alt="npm downloads" /></a> <a href="https://www.npmjs.com/package/discord.js"><img src="https://img.shields.io/npm/dt/discord.js.svg?maxAge=3600" alt="npm downloads" /></a>
<a href="https://github.com/discordjs/discord.js/actions"><img src="https://github.com/discordjs/discord.js/actions/workflows/test.yml/badge.svg" alt="Tests status" /></a> <a href="https://github.com/discordjs/discord.js/actions"><img src="https://github.com/discordjs/discord.js/actions/workflows/test.yml/badge.svg" alt="Tests status" /></a>
<a href="https://codecov.io/gh/discordjs/discord.js" ><img src="https://codecov.io/gh/discordjs/discord.js/branch/main/graph/badge.svg?precision=2" alt="Code coverage" /></a>
</p> </p>
<p> <p>
<a href="https://vercel.com/?utm_source=discordjs&utm_campaign=oss"><img src="https://raw.githubusercontent.com/discordjs/discord.js/main/.github/powered-by-vercel.svg" alt="Vercel" /></a> <a href="https://vercel.com/?utm_source=discordjs&utm_campaign=oss"><img src="https://raw.githubusercontent.com/discordjs/discord.js/main/.github/powered-by-vercel.svg" alt="Vercel" /></a>
@@ -103,27 +104,42 @@ client.login('token');
## Links ## Links
- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) - [Website][website] ([source][website-source])
- [Documentation](https://discord.js.org/#/docs) - [Documentation][documentation]
- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - [Guide][guide] ([source][guide-source])
See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. See also the [Update Guide][guide-update], including updated and removed items in the library.
- [discord.js Discord server](https://discord.gg/djs) - [discord.js Discord server][discord]
- [Discord API Discord server](https://discord.gg/discord-api) - [Discord API Discord server][discord-api]
- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/discord.js) - [GitHub][source]
- [npm](https://www.npmjs.com/package/discord.js) - [npm][npm]
- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) - [Related libraries][related-libs]
### Extensions ### Extensions
- [RPC](https://www.npmjs.com/package/discord-rpc) ([source](https://github.com/discordjs/RPC)) - [RPC][rpc] ([source][rpc-source])
## Contributing ## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
[documentation](https://discord.js.org/#/docs). [documentation][documentation].
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 ## 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](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

View File

@@ -15,20 +15,34 @@
## Links ## Links
- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) - [Website][website] ([source][website-source])
- [Documentation](https://discord.js.org/#/docs) - [Documentation][documentation]
- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - [Guide][guide] ([source][guide-source])
See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. See also the [Update Guide][guide-update], including updated and removed items in the library.
- [discord.js Discord server](https://discord.gg/djs) - [discord.js Discord server][discord]
- [Discord API Discord server](https://discord.gg/discord-api) - [Discord API Discord server][discord-api]
- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/scripts) - [GitHub][source]
- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) - [npm][npm]
- [Related libraries][related-libs]
## Contributing ## 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 ## 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](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

46
packages/guide/README.md Normal file
View File

@@ -0,0 +1,46 @@
<div align="center">
<br />
<p>
<a href="https://discord.js.org"><img src="https://discord.js.org/static/logo.svg" width="546" alt="discord.js" /></a>
</p>
<br />
<p>
<a href="https://discord.gg/djs"><img src="https://img.shields.io/discord/222078108977594368?color=5865F2&logo=discord&logoColor=white" alt="Discord server" /></a>
<a href="https://github.com/discordjs/discord.js/actions"><img src="https://github.com/discordjs/discord.js/actions/workflows/test.yml/badge.svg" alt="Build status" /></a>
</p>
<p>
<a href="https://vercel.com/?utm_source=discordjs&utm_campaign=oss"><img src="https://raw.githubusercontent.com/discordjs/discord.js/main/.github/powered-by-vercel.svg" alt="Vercel" /></a>
</p>
</div>
## 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

View File

@@ -50,17 +50,32 @@ const rest = new REST({
## Links ## Links
- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/website)) - [Website][website] ([source][website-source])
- [discord.js Discord server](https://discord.gg/djs) - [Documentation][documentation]
- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/proxy-container) - [Guide][guide] ([source][guide-source])
- [Docker Hub](https://hub.docker.com/r/discordjs/proxy) 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 ## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested. See [the contribution guide][contributing] if you'd like to submit a PR.
See [the contribution guide](https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md) 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](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

View File

@@ -32,23 +32,36 @@ pnpm add @discordjs/proxy
## Links ## Links
- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) - [Website][website] ([source][website-source])
- [Documentation](https://discord.js.org/#/docs/proxy) - [Documentation][documentation]
- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - [Guide][guide] ([source][guide-source])
See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. See also the [Update Guide][guide-update], including updated and removed items in the library.
- [discord.js Discord server](https://discord.gg/djs) - [discord.js Discord server][discord]
- [Discord API Discord server](https://discord.gg/discord-api) - [Discord API Discord server][discord-api]
- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/proxy) - [GitHub][source]
- [npm](https://www.npmjs.com/package/@discordjs/proxy) - [npm][npm]
- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) - [Related libraries][related-libs]
## Contributing ## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the 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). [documentation][documentation].
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 ## 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](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

View File

@@ -77,22 +77,36 @@ try {
## Links ## Links
- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) - [Website][website] ([source][website-source])
- [Documentation](https://discord.js.org/#/docs/rest) - [Documentation][documentation]
- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - [Guide][guide] ([source][guide-source])
See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. See also the [Update Guide][guide-update], including updated and removed items in the library.
- [discord.js Discord server](https://discord.gg/djs) - [discord.js Discord server][discord]
- [Discord API Discord server](https://discord.gg/discord-api) - [Discord API Discord server][discord-api]
- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/rest) - [GitHub][source]
- [npm](https://www.npmjs.com/package/@discordjs/rest) - [npm][npm]
- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) - [Related libraries][related-libs]
## Contributing ## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the 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). [documentation][documentation].
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 ## 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

View File

@@ -15,20 +15,32 @@
## Links ## Links
- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) - [Website][website] ([source][website-source])
- [Documentation](https://discord.js.org/#/docs) - [Documentation][documentation]
- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - [Guide][guide] ([source][guide-source])
See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. See also the [Update Guide][guide-update], including updated and removed items in the library.
- [discord.js Discord server](https://discord.gg/djs) - [discord.js Discord server][discord]
- [Discord API Discord server](https://discord.gg/discord-api) - [Discord API Discord server][discord-api]
- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/scripts) - [GitHub][source]
- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) - [Related libraries][related-libs]
## Contributing ## 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 ## 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](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

46
packages/ui/README.md Normal file
View File

@@ -0,0 +1,46 @@
<div align="center">
<br />
<p>
<a href="https://discord.js.org"><img src="https://discord.js.org/static/logo.svg" width="546" alt="discord.js" /></a>
</p>
<br />
<p>
<a href="https://discord.gg/djs"><img src="https://img.shields.io/discord/222078108977594368?color=5865F2&logo=discord&logoColor=white" alt="Discord server" /></a>
<a href="https://github.com/discordjs/discord.js/actions"><img src="https://github.com/discordjs/discord.js/actions/workflows/test.yml/badge.svg" alt="Build status" /></a>
</p>
<p>
<a href="https://vercel.com/?utm_source=discordjs&utm_campaign=oss"><img src="https://raw.githubusercontent.com/discordjs/discord.js/main/.github/powered-by-vercel.svg" alt="Vercel" /></a>
</p>
</div>
## 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

View File

@@ -13,22 +13,48 @@
</p> </p>
</div> </div>
## 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 ## Links
- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) - [Website][website] ([source][website-source])
- [Documentation](https://discord.js.org/#/docs) - [Documentation][documentation]
- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - [Guide][guide] ([source][guide-source])
See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. See also the [Update Guide][guide-update], including updated and removed items in the library.
- [discord.js Discord server](https://discord.gg/djs) - [discord.js Discord server][discord]
- [Discord API Discord server](https://discord.gg/discord-api) - [Discord API Discord server][discord-api]
- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/scripts) - [GitHub][source]
- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) - [npm][npm]
- [Related libraries][related-libs]
## Contributing ## 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 ## 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](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

View File

@@ -66,24 +66,36 @@ try installing another.
## Links ## Links
- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) - [Website][website] ([source][website-source])
- [Documentation](https://discord.js.org/#/docs/voice) - [Documentation][documentation]
- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - [Guide][guide] ([source][guide-source])
See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. See also the [Update Guide][guide-update], including updated and removed items in the library.
- [discord.js Discord server](https://discord.gg/djs) - [discord.js Discord server][discord]
- [Discord API Discord server](https://discord.gg/discord-api) - [Discord API Discord server][discord-api]
- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/voice) - [GitHub][source]
- [npm](https://www.npmjs.com/package/@discordjs/voice) - [npm][npm]
- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) - [Related libraries][related-libs]
- [Examples](https://github.com/discordjs/discord.js/tree/main/packages/voice/examples)
## Contributing ## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the 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). [documentation][documentation].
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 ## 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](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

View File

@@ -15,22 +15,32 @@
## Links ## Links
- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) - [Website][website] ([source][website-source])
- [Documentation](https://discord.js.org/#/docs) - [Documentation][documentation]
- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - [Guide][guide] ([source][guide-source])
See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. See also the [Update Guide][guide-update], including updated and removed items in the library.
- [discord.js Discord server](https://discord.gg/djs) - [discord.js Discord server][discord]
- [Discord API Discord server](https://discord.gg/discord-api) - [Discord API Discord server][discord-api]
- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/website) - [GitHub][source]
- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) - [Related libraries][related-libs]
## Contributing ## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the See [the contribution guide][contributing] if you'd like to submit a PR.
[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.
## 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](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

View File

@@ -105,23 +105,36 @@ manager.setStrategy(new WorkerShardingStrategy(manager, { shardsPerWorker: 'all'
## Links ## Links
- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website)) - [Website][website] ([source][website-source])
- [Documentation](https://discord.js.org/#/docs/ws) - [Documentation][documentation]
- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - [Guide][guide] ([source][guide-source])
See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library. See also the [Update Guide][guide-update], including updated and removed items in the library.
- [discord.js Discord server](https://discord.gg/djs) - [discord.js Discord server][discord]
- [Discord API Discord server](https://discord.gg/discord-api) - [Discord API Discord server][discord-api]
- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/ws) - [GitHub][source]
- [npm](https://www.npmjs.com/package/@discordjs/ws) - [npm][npm]
- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) - [Related libraries][related-libs]
## Contributing ## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the 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). [documentation][documentation].
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 ## 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](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