Documentation update (README.md)

MitchiLaser · Aug 17, 2023 · ce3f30c · ce3f30c
1 parent 7079611
commit ce3f30c
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -19,7 +19,15 @@ $ pip install timeforge
 This program has currently only a command line interface. Use
 
 ``` bash
-$ python -m timeforge --help
+$ timeforge --help
 ```
 
 to get an overview of the functionality. The PDF document with the form will be automatically downloaded from the PSE homepage.
+
+Furthermore this tool has a rudimentary but working UI. Only Linux and MAC are supported, maybe it also works on Windows. Call
+
+``` bash
+$ timeforge-tui
+```
+
+to start the user interface
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "TimeForge"
-version = "1.0.0"
+version = "1.0.1"
 authors = [
 	{ name="Michael Hohenstein", email="[email protected]" },
 ]