Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-18 12:33:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

simplify README

Browse Source
This commit is contained in:
Amish Shah
2016-12-09 17:37:48 +00:00
parent 275d9d3ce0
commit a54a62787d
1 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -17,13 +17,17 @@
</div> </div>
## About ## About
discord.js is a powerful node.js module that allows you to interact with the [Discord API](https://discordapp.com/developers/docs/intro) very easily. discord.js is a powerful node.js module that allows you to interact with the
It takes a much more object-oriented approach than most other JS Discord libraries, making your bot's code significantly tidier and easier to comprehend. [Discord API](https://discordapp.com/developers/docs/intro) very easily.
Usability and performance are key focuses of discord.js, and it also has nearly 100% coverage of the Discord API.
* Object-oriented
* Predictable abstractions
* Performant
* Nearly 100% coverage of the Discord API
## Installation ## Installation
**Node.js 6.0.0 or newer is required.** **Node.js 6.0.0 or newer is required.**
Ignore any warnings about unmet peer dependencies - all of them are optional. Ignore any warnings about unmet peer dependencies - all peer dependencies are optional.
Without voice support: `npm install discord.js --save` Without voice support: `npm install discord.js --save`
With voice support ([node-opus](https://www.npmjs.com/package/node-opus)): `npm install discord.js node-opus --save` With voice support ([node-opus](https://www.npmjs.com/package/node-opus)): `npm install discord.js node-opus --save`
@@ -60,7 +64,7 @@ A bot template using discord.js can be generated using [generator-discordbot](ht
## Web distributions ## Web distributions
Web builds of discord.js that are fully capable of running in browsers are available [here](https://github.com/hydrabolt/discord.js/tree/webpack). Web builds of discord.js that are fully capable of running in browsers are available [here](https://github.com/hydrabolt/discord.js/tree/webpack).
These are built by [Webpack 2](https://webpack.js.org/). The API is identical, but rather than using `require('discord.js')`, These are built using [Webpack 2](https://webpack.js.org/). The API is identical, but rather than using `require('discord.js')`,
the entire `Discord` object is available as a global (on the `window` object). the entire `Discord` object is available as a global (on the `window` object).
The ShardingManager and any voice-related functionality is unavailable in these builds. The ShardingManager and any voice-related functionality is unavailable in these builds.
@@ -78,7 +82,7 @@ The ShardingManager and any voice-related functionality is unavailable in these
## Contributing ## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
[documentation](https://discord.js.org/#/docs). [documentation](https://discord.js.org/#/docs).
See [the contributing guide](CONTRIBUTING.md) if you'd like to submit a PR. See [the contribution guide](CONTRIBUTING.md) if you'd like to submit a PR.
## Help ## Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle