diff --git a/README.md b/README.md index 53899e4..7098417 100644 --- a/README.md +++ b/README.md @@ -79,13 +79,19 @@ For more information, see the [documentation](https://pace-neutrons.github.io/in ## Installation -At the moment, the only way is to install manually via pip, either directly from GitHub: +Inline reference can be installed via pip: + +``` +pip install inline_reference +``` + +or manually from GitHub: ``` pip install git+https://github.com/pace-neutrons/inline_reference ``` -or from a local copy: +or a local copy: ``` git clone https://github.com/pace-neutrons/inline_reference.git diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 7f8d67f..69bce68 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -7,8 +7,15 @@ Installation Pip --- -Currently, the only way to install the extension is by ``pip`` from GitHub. This can be done either -directly from GitHub:: +The extension can be installed using pip:: + + pip install inline_reference + + +Manual installation +^^^^^^^^^^^^^^^^^^^ + +Alternatively, it can be installed manually, either from GitHub:: pip install git+https://github.com/pace-neutrons/inline_reference