mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-15 11:03:30 +01:00
Update readme and docs welcome (#616)
This commit is contained in:
committed by
Amish Shah
parent
799054df00
commit
e87c9bb9a0
10
README.md
10
README.md
@@ -4,10 +4,11 @@
|
|||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
[](https://discord.gg/bRCvFy9)
|
||||||
[](https://www.npmjs.com/package/discord.js)
|
[](https://www.npmjs.com/package/discord.js)
|
||||||
|
[](https://www.npmjs.com/package/discord.js)
|
||||||
[](https://travis-ci.org/hydrabolt/discord.js)
|
[](https://travis-ci.org/hydrabolt/discord.js)
|
||||||
[](https://david-dm.org/hydrabolt/discord.js)
|
[](https://david-dm.org/hydrabolt/discord.js)
|
||||||
[](https://www.npmjs.com/package/discord.js)
|
|
||||||
|
|
||||||
[](https://nodei.co/npm/discord.js/)
|
[](https://nodei.co/npm/discord.js/)
|
||||||
|
|
||||||
@@ -21,7 +22,9 @@ npm install --save discord.js
|
|||||||
npm install --save --no-optional 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
|
## Example Usage
|
||||||
```js
|
```js
|
||||||
@@ -51,4 +54,5 @@ bot.login('your token');
|
|||||||
* [Related Libraries](https://discordapi.com/unofficial/libs.html)
|
* [Related Libraries](https://discordapi.com/unofficial/libs.html)
|
||||||
|
|
||||||
## Contact
|
## 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).
|
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).
|
||||||
|
|||||||
@@ -4,10 +4,11 @@
|
|||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
[](https://discord.gg/bRCvFy9)
|
||||||
[](https://www.npmjs.com/package/discord.js)
|
[](https://www.npmjs.com/package/discord.js)
|
||||||
|
[](https://www.npmjs.com/package/discord.js)
|
||||||
[](https://travis-ci.org/hydrabolt/discord.js)
|
[](https://travis-ci.org/hydrabolt/discord.js)
|
||||||
[](https://david-dm.org/hydrabolt/discord.js)
|
[](https://david-dm.org/hydrabolt/discord.js)
|
||||||
[](https://www.npmjs.com/package/discord.js)
|
|
||||||
|
|
||||||
[](https://nodei.co/npm/discord.js/)
|
[](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!
|
||||||
Welcome to the discord.js rewrite documentation. The rewrite has taken a lot of time, but it should be much more
|
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
|
## 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.
|
||||||
|
|||||||
Reference in New Issue
Block a user