diff --git a/README.md b/README.md index c835085..d2ddb60 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,14 @@ The purpose of this plugin to share code for generating documentation across all ## Install -Install using `pip` or `uv` by either cloning this repo or accessing from pypi, e.g.: +Install the package from GitHub: ```sh -pip install sphinx-ape +pip install git+https://github.com/ApeWorX/sphinx-ape.git@main ``` +**NOTE**: Also, you may clone and the package first and install locally. + Try `sphinx-ape --help` to check if it's installed. ## Quick Usage