Merge pull request mammothbio-os#15 from mbiokyle29/docs-update-psql

update README.md with install info for hgvs/postgres
mbiokyle29 · Mar 28, 2024 · 06c1947 · 06c1947
2 parents 833c298 + efa7f14
commit 06c1947
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -11,7 +11,9 @@ Documentation for the project can be found [here](https://mammothbio-os-palamede
 
 ## Installing
 
-Palamedes is packaged in PyPI, to install simply run: `pip install palamedes`
+Palamedes uses the [hgvs](https://github.com/biocommons/hgvs) package as a dependency. At this time, `hgvs` requires `postgresql` system dependencies to be installed before use. Please see the [README](https://github.com/biocommons/hgvs/blob/main/README.md#installing-hgvs-locally) for install instructions if needed.
+
+Palamedes itself is packaged in PyPI, to install simply run: `pip install palamedes`
 
 ## Usage - CLI