initial commit

README.md

@@ -0,0 +1,41 @@
+# Lottery TUI
+
+[![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm.fming.dev)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![PyPI - Version](https://img.shields.io/pypi/v/lottery-tui.svg)](https://pypi.org/project/lottery-tui)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/lottery-tui.svg)](https://pypi.org/project/q3rcon-tui)
+
+-----
+
+![img](./img/tui.png)
+
+## Table of Contents
+
+- [Installation](#installation)
+- [License](#license)
+
+## Installation
+
+*with uv*
+
+```console
+uv tool install lottery-tui
+```
+
+*with pipx*
+
+```console
+pipx install lotter-tui
+```
+
+The TUI should now be discoverable as lottery-tui.
+
+## Use
+
+Launch the TUI, select a lottery and press the Draw button!
+
+To exit from the application press *q* or *Ctrl+q*
+
+## License
+
+`lottery-tui` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.