diff --git a/README.md b/README.md new file mode 100644 index 0000000..17c7012 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +# GitHub API Wrapper + +[![Discord Server Invite](https://discord.com/api/guilds/963406460107235328/widget.png)](https://discord.gg/DWhwsQ5TsT) + +Easy to use Python wrapper for the **GitHub API**. + +## Key Features +- Modern Pythonic Interface +- Easy to use + + +## Installing + +**Python 3.8 or higher is required to run the library** + +To install the library, run the following command: + +```bash +# On Linux or MacOS +python3 -m pip install -U github + +# On Windows +py -m pip install -U github +``` + + +## Links +- `Discord Server `_ +- `GitHub API Documentation `_ diff --git a/README.rst b/README.rst deleted file mode 100644 index 05d72b5..0000000 --- a/README.rst +++ /dev/null @@ -1,58 +0,0 @@ -Github API Wrapper -================== - -.. image:: https://discord.com/api/guilds/963406460107235328/widget.png - :target: https://discord.gg/DWhwsQ5TsT - :alt: Discord Server Invite - -Easy to use Python wrapper for the **Github API**. - -Key Features ------------- -- Modern Pythonic Interface -- Easy to use - - -Installing ----------- - -**Python 3.8 or higher is required to run the library** - -To install the library, run the following command: - -.. code:: sh - - # On Linux or MacOS - python3 -m pip install -U git+https://github.com/VarMonke/Github-Api-Wrapper - - # On Windows - py -m pip install -U git+https://github.com/VarMonke/Github-Api-Wrapper - -Quick Example -------------- - -.. code:: py - - import github - import asyncio - - async def main(): - client = await github.GHClient() - - user = await client.get_user(user='GithubPythonBot') - - print(user) - print(user.html_url) - - asyncio.run(main()) - -.. code:: sh - # Output - - https://github.com/GithubPythonBot - - -Links ------ -- `Discord Server `_ -- `GitHub API Documentation `_