Merge pull request #145 from mechmotum/update-docs

Update installation description to use PyPi
mechmotum · Oct 12, 2024 · 105deaa · 105deaa
2 parents 4e04e0d + 403b4f7
commit 105deaa
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -14,14 +14,13 @@ This package is still under development, therefore there is no guarantee on back
 compatibility.
 
 ## Installation
-`SymBRiM` is currently not available on `PyPI`. Therefore, you'll need to install the
-development version from GitHub using:
+`SymBRiM` is currently available on `PyPI`.
 ```bash
-pip install git+https://github.com/mechmotum/symbrim.git
+pip install symbrim
 ```
 The optional dependencies can be installed with:
 ```bash
-pip install git+https://github.com/moorepants/BicycleParameters.git
+pip install bicycleparameters
 pip install symmeplot
 ```
 

diff --git a/docs/guides/installation.rst b/docs/guides/installation.rst
@@ -7,14 +7,13 @@ Installation
 Installation Users
 ==================
 
-SymBRiM is currently not available on PyPI. Therefore, you'll need to install the
-development version from GitHub using: ::
+SymBRiM is currently available on PyPI. ::
 
-    pip install git+https://github.com/mechmotum/symbrim.git
+    pip install symbrim
 
 The optional dependencies can be installed with: ::
 
-    pip install git+https://github.com/moorepants/BicycleParameters.git
+    pip install bicycleparameters
     pip install symmeplot
 
 Installation Developers