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

Update docs landing page

Browse Source
This commit is contained in:
iCrawl
2017-09-03 18:40:49 +02:00
parent 18de265fcc
commit 4778a47cd4
2 changed files with 14 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/general/updating.md
View File

@@ -1,3 +1,7 @@
# Version 11.2.0
v11.2.0 features fixes a lot of bugs we encountered along the 11.1.0 release, as well as support for new features such as Message Attachments and UserGuildSettings.
See [the changelog](https://github.com/hydrabolt/discord.js/releases/tag/11.2.0) for a full list of changes, including information about deprecations.
# Version 11.1.0 # Version 11.1.0
v11.1.0 features improved voice and gateway stability, as well as support for new features such as audit logs and searching for messages. v11.1.0 features improved voice and gateway stability, as well as support for new features such as audit logs and searching for messages.
See [the changelog](https://github.com/hydrabolt/discord.js/releases/tag/11.1.0) for a full list of changes, including See [the changelog](https://github.com/hydrabolt/discord.js/releases/tag/11.1.0) for a full list of changes, including
@@ -118,9 +122,9 @@ The guild parameter that has been dropped from the guild-related events can stil
## Dates and timestamps ## Dates and timestamps
All dates/timestamps on the structures have been refactored to have a consistent naming scheme and availability. All dates/timestamps on the structures have been refactored to have a consistent naming scheme and availability.
All of them are named similarly to this: All of them are named similarly to this:
**Date:** `Message.createdAt` **Date:** `Message.createdAt`
**Timestamp:** `Message.createdTimestamp` **Timestamp:** `Message.createdTimestamp`
See the docs for each structure to see which date/timestamps are available on them. See the docs for each structure to see which date/timestamps are available on them.
@@ -149,7 +153,7 @@ A couple more important details:
* `Client.servers.length` ==> `client.guilds.size` (all instances of `server` are now `guild`) * `Client.servers.length` ==> `client.guilds.size` (all instances of `server` are now `guild`)
## No more callbacks! ## No more callbacks!
Version 9 eschews callbacks in favour of Promises. This means all code relying on callbacks must be changed. Version 9 eschews callbacks in favour of Promises. This means all code relying on callbacks must be changed.
For example, the following code: For example, the following code:
```js ```js

12
docs/general/welcome.md
View File

@@ -17,8 +17,8 @@
</div> </div>
# Welcome! # Welcome!
Welcome to the discord.js v11.1.0 documentation. Welcome to the discord.js v11.2.0 documentation.
v11.1.0 features improved voice and gateway stability, as well as support for new features such as audit logs and searching for messages. v11.2.0 features fixes a lot of bugs we encountered along the 11.1.0 release, as well as support for new features such as Message Attachments and UserGuildSettings.
## About ## About
discord.js is a powerful [node.js](https://nodejs.org) module that allows you to interact with the discord.js is a powerful [node.js](https://nodejs.org) module that allows you to interact with the
@@ -30,11 +30,11 @@ discord.js is a powerful [node.js](https://nodejs.org) module that allows you to
- 100% coverage of the Discord API - 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, as they're all optional. Ignore any warnings about unmet peer dependencies, as they're all 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`
With voice support ([opusscript](https://www.npmjs.com/package/opusscript)): `npm install discord.js opusscript --save` With voice support ([opusscript](https://www.npmjs.com/package/opusscript)): `npm install discord.js opusscript --save`
### Audio engines ### Audio engines
@@ -79,7 +79,7 @@ client.login('your token');
## 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 contribution guide](https://github.com/hydrabolt/discord.js/blob/master/.github/CONTRIBUTING.md) if you'd like to submit a PR. See [the contribution guide](https://github.com/hydrabolt/discord.js/blob/master/.github/CONTRIBUTING.md) if you'd like to submit a PR.
## Help ## Help