add note about pip

Signed-off-by: vsoch <vsoch@users.noreply.github.com>

.gitignore

@@ -1,6 +1,9 @@
 shpc.db
-singularity-hpc.egg-info/
+singularity_hpc.egg-info/
 .env
+build
+docs/_build
+release
 _site
 dist/
 OLD

README.md

@@ -1,6 +1,6 @@
 # Singularity Registry HPC (shpc)
 
-[![GitHub actions status](https://github.com/singularityhub/singularity-hpc/workflows/sregistry-ci/badge.svg?branch=master)](https://github.com/singularityhub/singularity-hpc/actions?query=branch%3Amain+workflow%3Asingularity-hpc)
+[![GitHub actions status](https://github.com/singularityhub/singularity-hpc/workflows/singularity-hpc/badge.svg?branch=main)](https://github.com/singularityhub/singularity-hpc/actions?query=branch%3Amain+workflow%3Asingularity-hpc)
 
 Singularity HPC is based off of the [Singularity Registry Client](https://github.com/singularityhub/sregistry-cli), but instead of
 being intended for general interaction with Singularity containers and a local database, it's optimized for managing containers
@@ -17,13 +17,7 @@ You can use shpc if you are:
 These use cases will be better flushed out and documented as the library is developed.
 
 📖️ Read the [documentation](https://singularity-hpc.readthedocs.io/en/latest/) 📖️
-
-## ✅️ Tests to write ✅️
-
- - Settings load, update, get, etc.
- - Ensure that all defaults are present in settings (except for updated at)
 
-
 ## 🎨️ Previous Art 🎨️
 
 There are other tools that you might be interested in!

docs/getting_started/installation.rst

@@ -65,3 +65,13 @@ Once it's installed, you should be able to inspect the client!
 
 You'll want to configure and create your registry, discussed next in
  :ref:`getting-started`.
+
+
+Pypi
+====
+
+The module is avaiable in pypi as [singularity-hpc](https://pypi.org/project/singularity-hpc/), 
+and this is primairly to have a consistent means for release, and an interface to show the package. Since the registry
+files will not install and you would need to change the registry path
+and module base (making it hard to update from the git remote) we do not
+encourage you to install from pip unless you know exactly what you are doing.