From d18705b86f3e9c16ad97c0a321099d921adf3684 Mon Sep 17 00:00:00 2001
From: Soheab <soheabdebeste@hotmail.com>
Date: Thu, 6 Aug 2020 18:26:00 +0200
Subject: [PATCH] add README.md

---
 .gitignore |  2 --
 README.md  | 84 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 84 insertions(+), 2 deletions(-)
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
index a8bfaa7..ed9c6ab 100644
--- a/.gitignore
+++ b/.gitignore
@@ -126,6 +126,4 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
-!/test_api.py
 test_api.py
-/READMEDONE.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bfcbce1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,84 @@
+[![PyPi Version](https://img.shields.io/pypi/v/vacefron.py.svg)](https://pypi.python.org/pypi/vacefron.py/)
+[![Downloads](https://pepy.tech/badge/vacefron-py)](https://pepy.tech/project/vacefron-py)
+[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/tterb/atomic-design-ui/blob/master/LICENSEs)
+
+
+# VACEfron.py
+A Wrapper for [vacefron.nl/api](https://vacefron.nl/api/) written in Python.
+
+
+# Requirements
+- Python 3.6 or above
+- aiohttp (python3 -m pip install -U aiohttp)
+
+# Documentation
+See the full and detailed [docs here](https://github.com/Soheab/vacefron.py/blob/master/docs.md)
+
+# Installation
+Install the package by doing one of the following commands:
+
+##### Using pip (recommended):
+- pip install vacefron.py -U
+- python -m pip install vacefron.py -U
+
+# Changelog
+See the changelog for each [version here](https://github.com/Soheab/vacefron.py/blob/master/changelog.md)
+
+# Examples
+
+Generate a Rank card with [discord.py](https://github.com/Rapptz/discord.py):
+```python
+import vacefron
+import json
+import discord
+
+from discord.ext import commands
+
+bot = commands.Bot(command_prefix="!")
+vac_api = vacefron.Client()
+
+@bot.command()
+async def rank(ctx):
+    with open("ranks.json") as f:
+        ranks = json.load(f)
+
+    info = ranks[f"{ctx.author.id}"]
+    boosting = True if ctx.author.premium_since else False
+    gen_card = await vac_api.rank_card(
+        username = ctx.author,
+        avatar = ctx.author.avatar_url,
+        level = int(info['level']),
+        rank = int(info['rank']),
+        current_xp = int(info['current_xp']),
+        next_level_xp = 500,
+        previous_level_xp = 50,
+        is_boosting = boosting
+        )
+    rank_bytes = await gen_card.read()
+    await ctx.send(f"{ctx.author.name}'s rank in {ctx.guild.name}",
+                   file = discord.File(rank_bytes, "rank.png")
+                   )
+```
+
+I can milk you meme [discord.py](https://github.com/Rapptz/discord.py):
+```python
+import vacefron
+import discord
+from discord.ext import commands
+
+bot = commands.Bot(command_prefix="!")
+vac_api = vacefron.Client()
+
+@bot.command()
+async def icanmilkyou(ctx, face: discord.Member, cow: discord.Member):
+    yes = await vac_api.i_can_milk_you(face.avatar_url, cow.avatar_url)
+    yes_bytes = discord.File(await yes.read(), "yes.png")
+    await ctx.send(file=yes_bytes)
+```
+
+# Made by
+
+This wrapper is made by **Soheab#6240**, DM me on Discord or [join my Server](https://discord.gg/yCzcfju) for anything 
+related to this wrapper.
+ 
+You can join VACEfron's [server here](https://discord.gg/TtR32WT) to suggests something for the API.