update to 0.0.3:

- fix escaping of tabs through command line
- improve README.md

Notes.md

@@ -0,0 +1,38 @@
+# How to publish
+
+## Pypi
+
+Create update:
+
+1) Change version number in [pyproject.toml](pyproject.toml)
+2) Create new package and upload:
+
+```bash
+# build: will create files in dist/
+poetry build
+# test: install .whl file
+pip install dist/scoary_2-*-py3-none-any.whl
+# upload
+poetry publish
+```
+
+## Docker / Podman
+
+If you use docker, simply replace each `podman` with `docker`.
+
+```shell
+podman build --tag troder/scoary-2 .
+```
+
+Publish docker image:
+
+```shell
+# podman login docker.io --get-login
+# podman login docker.io
+podman tag troder/scoary-2 troder/scoary-2:<scoary-version>
+podman push troder/scoary-2:<scoary-version>
+
+# update tag 'latest'
+podman tag troder/scoary-2 troder/scoary-2:latest
+podman push troder/scoary-2:latest
+```

README.md

@@ -57,6 +57,10 @@ docker run  \
     /bin/bash
 ```
 
+# Overview of the algorithm
+
+![algorithm flowchart](media/ScoaryWorkflow.drawio.svg)
+
 # Todo:
 
 - [X] Binarize traits during multiprocessing

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "scoary-2"
-version = "0.0.2"
+version = "0.0.3"
 description = "Scoary 2: Associate genes with traits!"
 authors = ["MrTomRod <[email protected]>"]
 license = "GPL3"