From d1778772cdb0935e3eac4479969625c2a010f11c Mon Sep 17 00:00:00 2001 From: anandre <38661761+anandre@users.noreply.github.com> Date: Sun, 21 Apr 2019 06:47:09 -0500 Subject: [PATCH] docs: update node version requirement, npm install links, add update guide (#3220) * Update welcome.md Update node version requirement, npm install links, docs links, made a note that the guide is for stable and added a new link to the WIP update guide. * docs(welcome.md): put notice for wip update guild on its own line * docs(welcome.md): indent own line * docs(README.md): apply the same changes here --- README.md | 13 +++++++------ docs/general/welcome.md | 13 +++++++------ 2 files changed, 14 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index faaa2bfd1e46..69a779fc8f33 100644 --- a/README.md +++ b/README.md @@ -27,12 +27,12 @@ discord.js is a powerful [Node.js](https://nodejs.org) module that allows you to - 100% coverage of the Discord API ## Installation -**Node.js 8.0.0 or newer is required.** +**Node.js 10.0.0 or newer is required.** Ignore any warnings about unmet peer dependencies, as they're all optional. -Without voice support: `npm install discord.js` -With voice support ([node-opus](https://www.npmjs.com/package/node-opus)): `npm install discord.js node-opus` -With voice support ([opusscript](https://www.npmjs.com/package/opusscript)): `npm install discord.js opusscript` +Without voice support: `npm install discordjs/discord.js` +With voice support ([node-opus](https://www.npmjs.com/package/node-opus)): `npm install discordjs/discord.js node-opus` +With voice support ([opusscript](https://www.npmjs.com/package/opusscript)): `npm install discordjs/discord.js opusscript` ### Audio engines The preferred audio engine is node-opus, as it performs significantly better than opusscript. When both are available, discord.js will automatically choose node-opus. @@ -68,8 +68,9 @@ client.login('token'); ## Links * [Website](https://discord.js.org/) ([source](https://github.com/discordjs/website)) -* [Documentation](https://discord.js.org/#/docs) -* [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) +* [Documentation](https://discord.js.org/#/docs/main/master/general/welcome) +* [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - this is still for stable + See also the WIP [Update Guide](https://github.com/discordjs/guide/blob/v12-changes/guide/additional-info/changes-in-v12.md) also including updated and removed items in the library. * [Discord.js Discord server](https://discord.gg/bRCvFy9) * [Discord API Discord server](https://discord.gg/discord-api) * [GitHub](https://github.com/discordjs/discord.js) diff --git a/docs/general/welcome.md b/docs/general/welcome.md index eb94f475a27b..2bc0525c7024 100644 --- a/docs/general/welcome.md +++ b/docs/general/welcome.md @@ -33,12 +33,12 @@ discord.js is a powerful [Node.js](https://nodejs.org) module that allows you to - 100% coverage of the Discord API ## Installation -**Node.js 8.0.0 or newer is required.** +**Node.js 10.0.0 or newer is required.** Ignore any warnings about unmet peer dependencies, as they're all optional. -Without voice support: `npm install discord.js` -With voice support ([node-opus](https://www.npmjs.com/package/node-opus)): `npm install discord.js node-opus` -With voice support ([opusscript](https://www.npmjs.com/package/opusscript)): `npm install discord.js opusscript` +Without voice support: `npm install discordjs/discord.js` +With voice support ([node-opus](https://www.npmjs.com/package/node-opus)): `npm install discordjs/discord.js node-opus` +With voice support ([opusscript](https://www.npmjs.com/package/opusscript)): `npm install discordjs/discord.js opusscript` ### Audio engines The preferred audio engine is node-opus, as it performs significantly better than opusscript. When both are available, discord.js will automatically choose node-opus. @@ -74,8 +74,9 @@ client.login('token'); ## Links * [Website](https://discord.js.org/) ([source](https://github.com/discordjs/website)) -* [Documentation](https://discord.js.org/#/docs) -* [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) +* [Documentation](https://discord.js.org/#/docs/main/master/general/welcome) +* [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - this is still for stable + See also the WIP [Update Guide](https://github.com/discordjs/guide/blob/v12-changes/guide/additional-info/changes-in-v12.md) also including updated and removed items in the library. * [Discord.js Discord server](https://discord.gg/bRCvFy9) * [Discord API Discord server](https://discord.gg/discord-api) * [GitHub](https://github.com/discordjs/discord.js)