From e87c9bb9a0fb5d6df08f300fcfda333274a47ea0 Mon Sep 17 00:00:00 2001 From: Schuyler Cebulskie Date: Mon, 5 Sep 2016 02:18:10 -0400 Subject: [PATCH] Update readme and docs welcome (#616) --- README.md | 10 +++++++--- docs/custom/documents/welcome.md | 16 +++++++++++++--- 2 files changed, 20 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index dfe3ce81c..5951841e2 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,11 @@

+[![Discord](https://discordapp.com/api/guilds/222078108977594368/embed.png)](https://discord.gg/bRCvFy9) [![npm](https://img.shields.io/npm/v/discord.js.svg?maxAge=2592000)](https://www.npmjs.com/package/discord.js) +[![npm](https://img.shields.io/npm/dt/discord.js.svg?maxAge=2592000)](https://www.npmjs.com/package/discord.js) [![Build Status](https://travis-ci.org/hydrabolt/discord.js.svg)](https://travis-ci.org/hydrabolt/discord.js) [![David](https://img.shields.io/david/hydrabolt/discord.js.svg?maxAge=2592000)](https://david-dm.org/hydrabolt/discord.js) -[![npm](https://img.shields.io/npm/dt/discord.js.svg?maxAge=2592000)](https://www.npmjs.com/package/discord.js) [![NPM](https://nodei.co/npm/discord.js.png?downloads=true&stars=true)](https://nodei.co/npm/discord.js/) @@ -21,7 +22,9 @@ npm install --save discord.js npm install --save --no-optional discord.js ``` -By default, discord.js uses [opusscript](https://www.npmjs.com/package/opusscript) when playing audio over voice connections. If you're looking to play over multiple voice connections, it might be better to install [node-opus](https://www.npmjs.com/package/node-opus). discord.js will automatically prefer node-opus over opusscript. +By default, discord.js uses [opusscript](https://www.npmjs.com/package/opusscript) when playing audio over voice connections. +If you're looking to play over multiple voice connections, it might be better to install [node-opus](https://www.npmjs.com/package/node-opus). +discord.js will automatically prefer node-opus over opusscript. ## Example Usage ```js @@ -51,4 +54,5 @@ bot.login('your token'); * [Related Libraries](https://discordapi.com/unofficial/libs.html) ## Contact -Before reporting an issue, please read the [documentation](http://hydrabolt.github.io/discord.js/#!/docs/tag/master). If you can't find help there, you can find help in the [Discord API Server](https://discord.gg/rV4BwdK). \ No newline at end of file +Before reporting an issue, please read the [documentation](http://hydrabolt.github.io/discord.js/#!/docs/tag/master). +If you can't find help there, you can ask in the official [Discord.js Server](https://discord.gg/bRCvFy9). diff --git a/docs/custom/documents/welcome.md b/docs/custom/documents/welcome.md index 1a9505799..b6f6725fa 100644 --- a/docs/custom/documents/welcome.md +++ b/docs/custom/documents/welcome.md @@ -4,10 +4,11 @@

+[![Discord](https://discordapp.com/api/guilds/222078108977594368/embed.png)](https://discord.gg/bRCvFy9) [![npm](https://img.shields.io/npm/v/discord.js.svg?maxAge=2592000)](https://www.npmjs.com/package/discord.js) +[![npm](https://img.shields.io/npm/dt/discord.js.svg?maxAge=2592000)](https://www.npmjs.com/package/discord.js) [![Build Status](https://travis-ci.org/hydrabolt/discord.js.svg)](https://travis-ci.org/hydrabolt/discord.js) [![David](https://img.shields.io/david/hydrabolt/discord.js.svg?maxAge=2592000)](https://david-dm.org/hydrabolt/discord.js) -[![npm](https://img.shields.io/npm/dt/discord.js.svg?maxAge=2592000)](https://www.npmjs.com/package/discord.js) [![NPM](https://nodei.co/npm/discord.js.png?downloads=true&stars=true)](https://nodei.co/npm/discord.js/) @@ -15,7 +16,16 @@ discord.js is a a powerful node.js module that allows you to interact with the [ # Welcome! Welcome to the discord.js rewrite documentation. The rewrite has taken a lot of time, but it should be much more -stable and performance-friendly than previous versions. +stable and performant than previous versions. ## Installation -`npm i --save discord.js` +**Requires node 6.0.0 and above** +```bash +npm install --save discord.js +# or, if you don't want voice support: +npm install --save --no-optional discord.js +``` + +By default, discord.js uses [opusscript](https://www.npmjs.com/package/opusscript) when playing audio over voice connections. +If you're looking to play over multiple voice connections, it might be better to install [node-opus](https://www.npmjs.com/package/node-opus). +discord.js will automatically prefer node-opus over opusscript.