From a99b628fcf415cfd0de1e09311e290d83bdf2e19 Mon Sep 17 00:00:00 2001 From: hydrabolt Date: Wed, 30 Sep 2015 18:51:07 +0100 Subject: [PATCH] Updated readme @ 3.6.1 --- README.md | 51 +++++++++------------------------------------------ package.json | 2 +- 2 files changed, 10 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index b83cdabae..38c7f8c09 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,13 @@

-[![Build Status](https://travis-ci.org/hydrabolt/discord.js.svg)](https://travis-ci.org/hydrabolt/discord.js) +[![Build Status](https://travis-ci.org/hydrabolt/discord.js.svg)](https://travis-ci.org/hydrabolt/discord.js) [![Documentation Status](https://readthedocs.org/projects/discordjs/badge/?version=latest)](http://discordjs.readthedocs.org/en/latest/?badge=latest) + discord.js is a node module used as a way of interfacing with [Discord](https://discordapp.com/). It is a very useful module for creating bots. -**Updating to 3.1.1 is essential as it has new changes to be compatible with Discord's API, -and to make sure your application still works an update is a good idea.** - ### Installation `npm install --save discord.js` @@ -46,7 +44,7 @@ Here is a list of other Discord APIs: [DiscordSharp](https://github.com/Luigifan/DiscordSharp) #### NodeJS -[node-discord](https://github.com/izy521/node-discord) (similar to discord.js but lower level) +[discord.io](https://github.com/izy521/node-discord) (similar to discord.js but lower level) #### PHP [DiscordPHP](https://github.com/teamreflex/DiscordPHP) @@ -59,42 +57,8 @@ Here is a list of other Discord APIs: --- -### Changes in 3.1.4 - -No, not π. But instead, pseduo-synchronous messaging was added! This means that -you can tell your Client to make a queue of "actions" per channel, and it will -work through them one by one. This is a really useful tool if you need to send -messages in a specific order without callback hell. - -It also allows you to store responses - such as created messages - in the returned -promise - named action. Example: - -```js -var mybot = new Discord.Client({ - queue : true //enable queueing, disabled by default -}); - -mybot.on("message", function(msg){ - - mybot.sendMessage(msg.channel, "this is message 1"); - var action = mybot.sendMessage(msg.channel, "this is message 2"); - mybot.sendMessage(msg.channel, "this is message 3").then(rmv); - - function rmv(){ - if(!action.error){ - mybot.deleteMessage(action.message); - } - } - -}); -``` - -This is still in development, and will see many more enhancements in future. - ---- - ### Links -**[Documentation](https://github.com/discord-js/discord.js/wiki/Documentation)** +**[Documentation](http://discordjs.readthedocs.org/en/latest/)** **[GitHub](https://github.com/discord-js/discord.js)** @@ -108,5 +72,8 @@ This is still in development, and will see many more enhancements in future. ### Contact -If you would like to contact me, you can create an issue on the GitHub repo -or send a DM to **hydrabolt** in [Discord API](https://discord.gg/0SBTUU1wZTYd2XyW). +If you have an issue or want to know if a feature exists, [read the documentation](http://discordjs.readthedocs.org/en/latest/) before contacting me about any issues! If it's badly/wrongly implemented, let me know! + + +If you would like to contact me, you can create an issue on the GitHub repo, e-mail me via the one available on my NPM profile. +Or you could just send a DM to **hydrabolt** in [**Discord API**](https://discord.gg/0SBTUU1wZTYd2XyW). diff --git a/package.json b/package.json index 458024ac2..2059611ee 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "discord.js", - "version": "3.6.0", + "version": "3.6.1", "description": "A way to interface with the Discord API", "main": "./lib/index.js", "scripts": {