1 files changed, 27 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..2bbeab9
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,27 @@
+# gpn-tron-rust
+
+A Rust rewrite of the GPN-Tron game. For more documentation see the
+[original on github](https://github.com/freehuntx/gpn-tron).
+
+## Installation
+
+Requirements:
+
+- esbuild
+- rust nightly
+
+```
+cargo install --git https://codeberg.org/metamuffin/gpn-tron-rust
+```
+
+## Usage
+
+```
+gpn-tron config.toml
+```
+
+A example configuration file is provided in the repo root.
+
+## License
+
+AGPL-3.0-only; See [COPYING](./COPYING)