Merge pull request #55 from hydrabolt/rewrite-docs

Finished docs (mainly)

Author: amishshah

README.md

@@ -4,24 +4,88 @@
   </a>
 </p>
 
-## Welcome to the rewrite branch!
+# Did v5.0.0 break your code? [Look here.](http://discordjs.readthedocs.org/en/rewrite-docs/migrating.html)
 
-The rewrite branch was created as a way of completely rewriting the API (once again) for complete stability. Versions <= 4.1.1 of the API would _always_ eventually crash for one reason or another.
+[![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)
+    
 
-So far, the rewrite branch seems to have achieved what was wanted, as it is much more stable and can handle mass joining and leaving of servers. Users, channels and servers are always cached properly, and the only time of expected crashes are when an error occurs in the WebSocket.
+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.
 
-You can start using the rewrite branch, but it is a breaking change. The documentation isn't done, but H
-here is the main notable change:
+**The examples in the repo are in ES6, either update your node or compile them down to babel yourself if you want to use them!**
 
+### Installation
+`npm install --save discord.js`
+
+---
+
+### Example
 ```js
-// old method:
-client.getUser("id", 12);
-client.getChannel("id", 12);
-client.getServer("id", 12);
-	// etc...
+var Discord = require("discord.js");
+
+var mybot = new Discord.Client();
+
+mybot.on("message", function(message){
 
-// new method:
-client.users.get("id", 12);
-client.channels.get("id", 12);
-client.servers.get("id", 12);
-```
+	if(message.content === "ping")
+		mybot.reply(message, "pong");
+	
+});
+
+mybot.login("email", "password");
+```
+---
+
+### What's new in 5.0.0?
+
+Stability in general! The API has been rewritten completely for much better stability, and it seems to have worked! There are now no random crashes and everything caches properly. The API is also a bit cleaner!
+
+However, it is a breaking change if you are updating (potentially, basic code should be fine) you should look [here](http://discordjs.readthedocs.org/en/rewrite-docs/migrating.html) for help updating.
+
+---
+
+### Related Projects
+
+Here is a list of other Discord APIs:
+
+#### Java:
+[Discord4J](https://github.com/nerd/Discord4J)
+#### .NET:
+[Discord.Net](https://github.com/RogueException/Discord.Net)
+
+[DiscordSharp](https://github.com/Luigifan/DiscordSharp)
+#### NodeJS
+[discord.io](https://github.com/izy521/node-discord) (similar to discord.js but lower level)
+
+#### PHP
+[DiscordPHP](https://github.com/teamreflex/DiscordPHP)
+
+#### Python
+[discord.py](https://github.com/Rapptz/discord.py)
+
+#### Ruby
+[discordrb](https://github.com/meew0/discordrb)
+
+---
+
+### Links
+**[Documentation](http://discordjs.readthedocs.org/en/latest/)**
+
+**[GitHub](https://github.com/discord-js/discord.js)**
+
+**[Wiki](https://github.com/discord-js/discord.js/wiki)**
+
+**[Website](http://discord-js.github.io/)**
+
+**[NPM](npmjs.com/package/discord.js)**
+
+---
+
+### Contact
+
+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).

docs/create_simple_bot.rst

@@ -0,0 +1,43 @@
+.. include:: ./vars.rst
+
+Cache
+=====
+
+**extends Array**
+
+A Cache object extends an Array (so it can be used like a regular array) but introduces helper functions to make it more useful when developing with discord.js. Unlike a regular array, it doesn't care about the instance or prototype of an object, it works purely on properties.
+
+-----
+
+Functions
+---------
+
+get(key, value)
+~~~~~~~~~~~~~~~
+
+Returns a contained object where ``object[key] == value``. Returns the first object found that matches the criteria.
+
+getAll(key, value)
+~~~~~~~~~~~~~~~~~~
+
+Similar to ``cache.get(key, value)``, but returns a Cache of any objects that meet the criteria. 
+
+has(key, value)
+~~~~~~~~~~~~~~~
+
+Returns `true` if there is an object that meets the condition ``object[key] == value`` in the cache
+
+add(data)
+~~~~~~~~~
+
+Adds an object to the Cache as long as all the other objects in the cache don't have the same ID as it.
+
+update(old, data)
+~~~~~~~~~~~~~~~~~
+
+Updates an old object in the Cache (if it exists) with the new one.
+
+remove(data)
+~~~~~~~~~~~~
+
+Removes an object from the cache if it exists.

docs/docs_cache.rst

@@ -1,82 +1,23 @@
-.. include:: ./vars.rst
-
-Channels
-========
-
-The Channel Class is used to represent data about a Channel.
-
-Attributes
-----------
-
-client
-~~~~~~
-
-The Discord Client_ that cached the channel
-
-server
-~~~~~~
-
-The Server_ that the channel belongs to
-
-name
-~~~~
-
-The channel's name, as a `String`.
-
-id
-~~
-
-The channel's id, as a `String`.
-
-type
-~~~~
-
-The type of the channel as a `String`, either ``text`` or ``voice``.
-
-topic
-~~~~~
-
-A `String` that is the topic of the channel, if the channel doesn't have a topic this will be `null`.
-
-messages
-~~~~~~~~
-
-An `Array` of Message_ objects received from the channel. There are up to a 1000 messages here, and the older messages will be deleted if necessary.
-
-members
-~~~~~~~
-
-**Aliases** : `users`
-
-The members in the channel's server, an `Array` of User_ objects.
-
------
-
-Functions
----------
-
-.. note:: When concatenated with a String, the object will become the channel's embed code, e.g. ``"this is " + channel`` would be ``this is <#channelid>``
-
-getMessage(key, value)
-~~~~~~~~~~~~~~~~~~~~~~
-
-Gets a Message_ from the channel that matches the specified criteria. E.g:
-
-.. code-block:: js
-
-    channel.getMessage("id", 1243987349) // returns a Message where message.id === 1243987349
-    
-- **key** - a `String` that is the key
-- **value** - a `String` that is the value
-
-permissionsOf(user)
-~~~~~~~~~~~~~~~~~~~
-
-Gets the EvaluatedPermissions_ of a User in the channel.
-
-- **user** - A User_ or Member_ you want to get the permissions of.
-
-equals(object)
-~~~~~~~~~~~~~~
-
-Returns a `Boolean` depending on whether the Channel's ID (``channel.id``) equals the object's ID (``object.id``). You should **always**, always use this if you want to compare channels. **NEVER** do ``channel1 == channel2``.
+.. include:: ./vars.rst
+
+Channel
+=======
+
+**extends** Equality_
+
+The Channel class is the base class for all types of channel.
+
+Attributes
+----------
+
+--------
+
+id
+~~
+
+The ID of the channel, a `String`.
+
+client
+~~~~~~
+
+The Client_ that cached the channel.