From fcf2897e46a210e1585b644265a12ecd4a1e70d3 Mon Sep 17 00:00:00 2001 From: RGBCube <78925721+RGBCube@users.noreply.github.com> Date: Tue, 21 Jun 2022 18:50:16 +0300 Subject: [PATCH] Cleanup README --- README.rst | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index c99efab..05d72b5 100644 --- a/README.rst +++ b/README.rst @@ -16,16 +16,16 @@ Key Features Installing ---------- -**Python 3.8 or higher** +**Python 3.8 or higher is required to run the library** -To install the library, run the following command +To install the library, run the following command: .. code:: sh - #Linux/macOS + # On Linux or MacOS python3 -m pip install -U git+https://github.com/VarMonke/Github-Api-Wrapper - #Windows + # On Windows py -m pip install -U git+https://github.com/VarMonke/Github-Api-Wrapper Quick Example @@ -38,18 +38,21 @@ Quick Example async def main(): client = await github.GHClient() - return await client.get_user(user='GithubPythonBot') - user = asyncio.run(main()) - print(user) - print(user.html_url) + user = await client.get_user(user='GithubPythonBot') + + print(user) + print(user.html_url) + + asyncio.run(main()) .. code:: sh - #Output + # Output https://github.com/GithubPythonBot Links ----- -`Discord Server `_ \ No newline at end of file +- `Discord Server `_ +- `GitHub API Documentation `_