Merge pull request #4 from TomJGooding/docs-update-readme-as-wip

docs: update readme as wip
TomJGooding · Apr 3, 2024 · f4eeb6d · f4eeb6d
2 parents 78cde9b + afec913
commit f4eeb6d
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,14 @@
-# pypi-search-tui
+# pypi-search-tui
+
+> [!WARNING]
+> This project is currently a work in progress
+
+## Demo
+
+```
+python -m pypi_search_tui
+```
+
+## Licence
+
+Licensed under the [GNU General Public License v3.0](LICENSE).