update readme

liesel-devs · Mar 24, 2024 · 91b10e9 · 91b10e9
1 parent bd7e0c8
commit 91b10e9
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -29,9 +29,13 @@
 The library can be installed from GitHub:
 
 ``` bash
-pip install git+https://github.com/liesel-devs/liesel-ptm.git#egg=liesel_ptm
+pip install "git+https://github.com/liesel-devs/liesel-ptm.git@<VERSION_TAG>#egg=liesel_ptm"
 ```
 
+In the above line, replace `<VERSION_TAG>` with the desired version to
+install. Available releases can be viewed
+[here](https://github.com/liesel-devs/liesel-ptm/releases).
+
 ## Example usage
 
 To demonstrate how the individual parts can be used together, you can

diff --git a/README.qmd b/README.qmd
@@ -25,9 +25,12 @@ location and scale. Here's a quick overview:
 The library can be installed from GitHub:
 
 ```bash
-pip install git+https://github.com/liesel-devs/liesel-ptm.git#egg=liesel_ptm
+pip install "git+https://github.com/liesel-devs/liesel-ptm.git@<VERSION_TAG>#egg=liesel_ptm"
 ```
 
+In the above line, replace `<VERSION_TAG>` with the desired version to install.
+Available releases can be viewed [here](https://github.com/liesel-devs/liesel-ptm/releases).
+
 ## Example usage
 
 To demonstrate how the individual parts can be used together, you can find