mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-10 16:43:31 +01:00
Update README
This commit is contained in:
50
README.md
50
README.md
@@ -2,5 +2,51 @@
|
||||
<a href="https://hydrabolt.github.io/discord.js">
|
||||
<img alt="discord.js" src="http://i.imgur.com/sPOLh9y.png" width="546"><br />
|
||||
</a>
|
||||
<div align="center"><h1><i>REWRITE</i></h1></div>
|
||||
</p>
|
||||
</p>
|
||||
[](https://www.npmjs.com/package/discord.js)
|
||||
[](https://travis-ci.org/hydrabolt/discord.js)
|
||||
[](https://david-dm.org/hydrabolt/discord.js)
|
||||
[](https://www.npmjs.com/package/discord.js)
|
||||
|
||||
[](https://nodei.co/npm/discord.js/)
|
||||
|
||||
discord.js is a a powerful node.js module that allows you to interact with the [Discord API](https://discordapp.com/developers/docs/intro).
|
||||
|
||||
## Installation
|
||||
**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.
|
||||
|
||||
## Example Usage
|
||||
```js
|
||||
const Discord = require('discord.js');
|
||||
const bot = new Discord.Client();
|
||||
|
||||
bot.on('ready', () => {
|
||||
console.log('I am ready!');
|
||||
});
|
||||
|
||||
bot.on('message', message => {
|
||||
if (message.content === 'ping') {
|
||||
message.reply('pong');
|
||||
}
|
||||
});
|
||||
|
||||
bot.login('your token');
|
||||
```
|
||||
|
||||
## Links
|
||||
* [Website](http://hydrabolt.github.io/discord.js/)
|
||||
* [Documentation](http://hydrabolt.github.io/discord.js/#!/docs/tag/master)
|
||||
* [GitHub](https://github.com/hydrabolt/discord.js)
|
||||
* [NPM](https://www.npmjs.com/package/discord.js)
|
||||
* [Examples](https://github.com/hydrabolt/discord.js/tree/master/examples)
|
||||
* [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).
|
||||
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user