From 674ea664edff110615071d6af76f11ac0855af30 Mon Sep 17 00:00:00 2001 From: hydrabolt Date: Wed, 28 Oct 2015 14:46:42 +0000 Subject: [PATCH] Final update on docs for now --- docs/docs_client.rst | 2 -- docs/get_started.rst | 6 +++--- docs/index.rst | 7 +++++-- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/docs_client.rst b/docs/docs_client.rst index 0f434e2a8..c33098212 100644 --- a/docs/docs_client.rst +++ b/docs/docs_client.rst @@ -569,8 +569,6 @@ Registering Events bot.on("eventName", function(arg1, arg2...){ // code here is called when eventName is emitted. }) - -.. note:: You can only have one listening function per event Unregistering Events ~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/get_started.rst b/docs/get_started.rst index ed857ddf9..69745a23c 100644 --- a/docs/get_started.rst +++ b/docs/get_started.rst @@ -8,17 +8,17 @@ Installation Linux ~~~~~~ -Install Python 2.x.x and then run ``npm install discord.js --save`` in your project's directory and you should be good to go! +Install Python 2 and then run ``npm install discord.js --save`` in your project's directory and you should be good to go! OS X ~~~~ -Python 2.x.x and **potentially** X Code, try building without first. +Python 2 and **potentially** X Code, try building without first. Windows ~~~~~~~~~~~~ -**TL;DR You need Visual Studio Community and Python 2.x.x** +**TL;DR You need Visual Studio and Python 2** Unfortunately, the Windows installation process is a little more lengthy. You need to have `Visual Studio Express`_ (or any of the other distributions of it). This is necessary for build tools for the WebSocket dependency. diff --git a/docs/index.rst b/docs/index.rst index 15745de03..e89ef708d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,8 +6,10 @@ Welcome to discord.js's documentation! ====================================== -discord.js is an easy-to-use and intuitive JavaScript API for Discord_. It should be able to -run in node.js / io.js and in the browser. +discord.js is an easy-to-use and intuitive JavaScript API for Discord_. It's fairly high level, so if you're +looking for something low level, check out `discord.io`_. + +Feel free to make any contributions you want, whether it be through creating an issue, giving a suggestion or making a pull request! .. note:: This documentation is still a work-in-progress, apologies if something isn't yet documented! @@ -50,3 +52,4 @@ Indices and tables * :ref:`search` .. _Discord : https://discordapp.com/ +.. _discord.io : https://github.com/izy521/discord.io