Updated readme

This commit is contained in:
Samuel Roach 2022-06-01 14:43:09 +01:00
parent bc09c3d58d
commit 47dd8f9bbf
2 changed files with 4 additions and 2 deletions

View File

@ -24,8 +24,10 @@ pip install ergast-py
Once ergast-py is installed on your system you can then begin using the library in querying the ergast API. To begin, initialise an instance of the ``Ergast()`` class. Once ergast-py is installed on your system you can then begin using the library in querying the ergast API. To begin, initialise an instance of the ``Ergast()`` class.
Note: Whilst the package is called ``ergast-py``, you need to import ``ergast_py``
```python ```python
from ergast-py import Ergast from ergast_py import ergast.Ergast
e = Ergast() e = Ergast()
``` ```

View File

@ -1,7 +1,7 @@
[tool.poetry] [tool.poetry]
name = "ergast-py" name = "ergast-py"
version = "0.1.0" version = "0.1.0"
description = "" description = "A comprehensive Python wrapper for the Ergast API. Available at: https://github.com/Samuel-Roach/ergast-py"
authors = ["Samuel Roach <samuelroach.2000@gmail.com>"] authors = ["Samuel Roach <samuelroach.2000@gmail.com>"]
[tool.poetry.dependencies] [tool.poetry.dependencies]