diff options
Diffstat (limited to 'node_modules/discord.js/README.md')
| -rw-r--r-- | node_modules/discord.js/README.md | 86 |
1 files changed, 0 insertions, 86 deletions
diff --git a/node_modules/discord.js/README.md b/node_modules/discord.js/README.md deleted file mode 100644 index abb18fb..0000000 --- a/node_modules/discord.js/README.md +++ /dev/null @@ -1,86 +0,0 @@ -<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/bRCvFy9"><img src="https://discordapp.com/api/guilds/222078108977594368/embed.png" alt="Discord server" /></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://travis-ci.org/discordjs/discord.js"><img src="https://travis-ci.org/discordjs/discord.js.svg" alt="Build status" /></a> - <a href="https://david-dm.org/discordjs/discord.js"><img src="https://img.shields.io/david/discordjs/discord.js.svg?maxAge=3600" alt="Dependencies" /></a> - </p> - <p> - <a href="https://nodei.co/npm/discord.js/"><img src="https://nodei.co/npm/discord.js.png?downloads=true&stars=true" alt="NPM info" /></a> - </p> -</div> - -## About -discord.js is a powerful [node.js](https://nodejs.org) module that allows you to interact with the -[Discord API](https://discordapp.com/developers/docs/intro) very easily. - -- Object-oriented -- Predictable abstractions -- Performant -- 100% coverage of the Discord API - -## Installation -**Node.js 6.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 ([@discordjs/opus](https://www.npmjs.com/package/@discordjs/opus)): `npm install discord.js @discordjs/opus` -With voice support ([opusscript](https://www.npmjs.com/package/opusscript)): `npm install discord.js opusscript` - -### Audio engines -The preferred audio engine is @discordjs/opus, as it performs significantly better than opusscript. When both are available, discord.js will automatically choose @discordjs/opus. -Using opusscript is only recommended for development environments where @discordjs/opus is tough to get working. -For production bots, using @discordjs/opus should be considered a necessity, especially if they're going to be running on multiple servers. - -### Optional packages -- [bufferutil](https://www.npmjs.com/package/bufferutil) to greatly speed up the WebSocket when *not* using uws (`npm install bufferutil`) -- [erlpack](https://github.com/hammerandchisel/erlpack) for significantly faster WebSocket data (de)serialisation (`npm install hammerandchisel/erlpack`) -- One of the following packages can be installed for faster voice packet encryption and decryption: - - [sodium](https://www.npmjs.com/package/sodium) (`npm install sodium`) - - [libsodium.js](https://www.npmjs.com/package/libsodium-wrappers) (`npm install libsodium-wrappers`) - -## Example usage -```js -const Discord = require('discord.js'); -const client = new Discord.Client(); - -client.on('ready', () => { - console.log(`Logged in as ${client.user.tag}!`); -}); - -client.on('message', msg => { - if (msg.content === 'ping') { - msg.reply('pong'); - } -}); - -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)) -* [Discord.js Discord server](https://discord.gg/bRCvFy9) -* [Discord API Discord server](https://discord.gg/discord-api) -* [GitHub](https://github.com/discordjs/discord.js) -* [NPM](https://www.npmjs.com/package/discord.js) -* [Related libraries](https://discordapi.com/unofficial/libs.html) - -### Extensions -* [RPC](https://www.npmjs.com/package/discord-rpc) ([source](https://github.com/discordjs/RPC)) - -## Contributing -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation](https://discord.js.org/#/docs). -See [the contribution guide](https://github.com/discordjs/discord.js/blob/master/.github/CONTRIBUTING.md) 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](https://discord.gg/bRCvFy9). |