Add installation instructions for ribasim_api (#749)

Seems like PyPI changes `_` to `-` :(
Deltares · Nov 13, 2023 · 045d9c7 · 045d9c7
1 parent fda99d3
commit 045d9c7
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 1 deletion.
diff --git a/python/ribasim_api/README.md b/python/ribasim_api/README.md
@@ -0,0 +1,23 @@
+# Ribasim API
+
+`ribasim_api` is an extension to [xmipy](https://pypi.org/project/xmipy/) for the Ribasim API.
+
+The `ribasim_api` can be used to access functionality in the eXtended Model Interface (XMI) wrapper (XmiWrapper)
+and additional functionality specific to the Ribasim API.
+
+
+`ribasim_api` can be installed by running
+
+```
+pip install ribasim-api
+```
+
+or
+
+```
+conda install -c conda-forge ribasim-api
+```
+
+# Contributing
+
+For the developer docs please have a look at https://deltares.github.io/Ribasim/python/developer.html
diff --git a/python/ribasim_api/ribasim_api/__init__.py b/python/ribasim_api/ribasim_api/__init__.py
@@ -1,4 +1,4 @@
-__version__ = "0.3.0"
+__version__ = "0.4.0"
 
 from ribasim_api.ribasim_api import RibasimApi