Initial commit

1 files changed, 48 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..890d2401
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# PyDiscord
+
+PyDiscord is an API wrapper for Discord written in Python.
+
+This was written to allow easier writing of bots or chat logs.
+
+## This module is alpha!
+
+The discord API is constantly changing and the wrapper API is as well. There will be no effort to keep backwards compatibility.
+
+## Quick Example
+
+```py
+import discord
+
+client = discord.Client()
+client.login('email', 'password')
+
[email protected]
+def on_message(message):
+    if message.content.startswith('!hello'):
+        client.send_message(message.channel, 'Hello was received!')
+
[email protected]
+def on_ready():
+    print('Logged in as')
+    print(client.user.name)
+    print(client.user.id)
+    print('------')
+
+client.run()
+```
+
+## Requirements
+
+- Python 2.7+ or Python 3.3+.
+- `ws4py` library
+- `requests` library
+
+Usually `pip` will handle these for you.
+
+## Related Projects
+
+- [discord.js](https://github.com/discord-js/discord.js)
+- [node-discord](https://github.com/izy521/node-discord)
+- [Discord.NET](https://github.com/RogueException/Discord.Net)
+- [DiscordSharp](https://github.com/Luigifan/DiscordSharp)
+- [Discord4J](https://github.com/knobody/Discord4J)