.. PUBGy documentation master file, created by
   sphinx-quickstart on Tue Feb 25 02:01:15 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to PUBGy
=================================
PUBGy is a beginner-friendly, fully implemented, asynchronous API wrapper for  PLAYERUNKNOWN'S BATTLEGROUNDS (PUBG).

Before starting, ensure that you've first created an account and have acquired an API token via https://developer.pubg.com/

Installation
-----------------------

To install using PyPI: ::

    python -m pip install -U pubgy

Building from source (warning: this may be an unstable version of PUBGy, ensure you know what you are doing): ::

    git clone https://github.com/Discord-ian/pubgy.git
    cd pubgy
    python setup.py install

Documentation
---------------------------------
.. toctree::
   :maxdepth: 3

   reference