From 7411c06dbdecac93cb1d788a31ff3189c3ce4fc4 Mon Sep 17 00:00:00 2001
From: Tor-Einar Skog <tor-einar.skog@nibio.no>
Date: Wed, 1 Feb 2023 14:31:45 +0100
Subject: [PATCH] Docs update

---
 README.md | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 4cba6e8..4536f44 100644
--- a/README.md
+++ b/README.md
@@ -2,19 +2,25 @@
 
 # VIPSCore-Python-Common
 
-This is the source code for the module that contains the common data models and utilities for the Python implementation(s) of VIPS. It can be imported with pip like this:
+This is the source code for the module that contains the common data models and utilities for the Python implementation(s) of VIPS. It can be installed with pip like this:
 
 ``` bash
-pip3 install TODOTODOTODO
+# From local path, if you've cloned the Git repo
+pip3 install /home/foo/vipscore-python-common/
+# From GitLab
+pip3 install git+https://gitlab.nibio.no/VIPS/vipscore-python-common.git@v0.6.3
 ```
-
+...where the version is specified after the `@`
 
 
 ## Unit tests
-The tests are located in the `src/vipscore_common/tests` folder, and we're using Python's standard [`unittest` library](https://docs.python.org/3/library/unittest.html)
+The tests are located in the `tests` folder, and we're using [Pytest](https://docs.pytest.org/)
 
 To run the unit tests, move to the root folder of the project, and execute:
 
 ``` bash
-python3 -m unittest discover -s tests -t src/vipscore_common
-```
\ No newline at end of file
+pytest -v
+```
+
+## References
+We used this excellent guide for packaging: https://realpython.com/pypi-publish-python-package/ 
\ No newline at end of file
-- 
GitLab