aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorromangraef <romangraef@loves.dicksinhisan.us>2018-08-18 21:47:30 +0200
committerromangraef <romangraef@loves.dicksinhisan.us>2018-08-18 21:47:30 +0200
commit0e87d757dc3985fd5eb7696b354af292ca2fc141 (patch)
tree5a91d67f6da7a2031e85370cda5ed49fe6b8e97f
parent37de0904bc502358cada1be923b5bf2470e4cb94 (diff)
downloaddiscord_ban_list-0e87d757dc3985fd5eb7696b354af292ca2fc141.tar.gz
discord_ban_list-0e87d757dc3985fd5eb7696b354af292ca2fc141.tar.bz2
discord_ban_list-0e87d757dc3985fd5eb7696b354af292ca2fc141.zip
README
-rw-r--r--README.md27
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
+