README

1 files changed, 27 insertions, 0 deletions

diff --git a/README.md b/README.md
index e69de29..a087588 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,27 @@
+# Discord Ban List wrapper for python
+
+Non-official wrapper for [Discord bans][dbans].
+
+## Installation
+
+just `pip` install `https://github.com/romangraef/discord_ban_list/archive/master.zip`
+
+## Usage
+
+```python
+from discord_ban_list import DiscordBanList
+ban_list = DiscordBanList('YOUR_TOKEN')
+
+async def on_something():
+    ban_entry = ban_list.check(123456789123456789)
+    print(ban_entry.banned)
+    print(ban.user_id)
+    print(ban.case_id)
+    print(ban.reason)
+    print(ban.proof)
+
+```
+
+
+[dbans]: https://bans.discord.id
+