From 8f71f78ca970f8445e2466b4038c2a192db034e0 Mon Sep 17 00:00:00 2001
From: Tor-Einar Skog <tor-einar.skog@nibio.no>
Date: Wed, 1 Feb 2023 15:20:07 +0100
Subject: [PATCH] More docs updates

---
 README.md | 25 +++++++++++++++++++++++--
 1 file changed, 23 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 241ae85..087dd06 100644
--- a/README.md
+++ b/README.md
@@ -12,8 +12,17 @@ pip3 install git+https://gitlab.nibio.no/VIPS/vipscore-python-common.git@v0.1.6
 ```
 ...where the version is specified after the `@`
 
+If you're implementing a VIPS model, typical imports would be
 
-## Unit tests
+``` python
+from vipscore_common.vips_model import VIPSModel
+from vipscore_common.entities import Result, ModelConfiguration, WeatherObservation
+from vipscore_common.data_utils import *
+```
+
+## Developer guide
+
+### Unit tests
 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:
@@ -22,5 +31,17 @@ To run the unit tests, move to the root folder of the project, and execute:
 pytest -v
 ```
 
-## References
+### Using bumpver
+For developers: When you want to publish a new version, use
+``` bash
+# Increment the PATCH version when you make backwards compatible bug fixes.
+bumpver update --patch
+# Increment the MINOR version when you add functionality in a backwards compatible manner.
+bumpver update --minor
+# Increment the MAJOR version when you make incompatible API changes.
+bumpver update --major
+```
+[(Source)](https://semver.org/#summary)
+
+### References
 We used this excellent guide for packaging: https://realpython.com/pypi-publish-python-package/ 
\ No newline at end of file
-- 
GitLab