From 47dd8f9bbf7879b0e8f48f22a984bd7ed72f4c1b Mon Sep 17 00:00:00 2001 From: Samuel Roach Date: Wed, 1 Jun 2022 14:43:09 +0100 Subject: [PATCH] Updated readme --- README.md | 4 +++- pyproject.toml | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fc792db..e0eac71 100644 --- a/README.md +++ b/README.md @@ -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. +Note: Whilst the package is called ``ergast-py``, you need to import ``ergast_py`` + ```python -from ergast-py import Ergast +from ergast_py import ergast.Ergast e = Ergast() ``` diff --git a/pyproject.toml b/pyproject.toml index f5a9d6f..36fdc5f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,7 +1,7 @@ [tool.poetry] name = "ergast-py" 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 "] [tool.poetry.dependencies]