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

Final update on docs for now

Browse Source
This commit is contained in:
hydrabolt
2015-10-28 14:46:42 +00:00
parent 9d845ba18e
commit 674ea664ed
3 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs_client.rst
View File

@@ -570,8 +570,6 @@ Registering Events
// code here is called when eventName is emitted. // code here is called when eventName is emitted.
}) })
.. note:: You can only have one listening function per event
Unregistering Events Unregistering Events
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~

6
docs/get_started.rst
View File

@@ -8,17 +8,17 @@ Installation
Linux 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 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 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. 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.

7
docs/index.rst
View File

@@ -6,8 +6,10 @@
Welcome to discord.js's documentation! Welcome to discord.js's documentation!
====================================== ======================================
discord.js is an easy-to-use and intuitive JavaScript API for Discord_. It should be able to discord.js is an easy-to-use and intuitive JavaScript API for Discord_. It's fairly high level, so if you're
run in node.js / io.js and in the browser. 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! .. 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` * :ref:`search`
.. _Discord : https://discordapp.com/ .. _Discord : https://discordapp.com/
.. _discord.io : https://github.com/izy521/discord.io