From 6afee2d10243bcf1455245aa99cf2aeb6edbed99 Mon Sep 17 00:00:00 2001
From: Patrick Auernig <patrick.auernig@mykolab.com>
Date: Wed, 9 Aug 2023 15:26:20 +0200
Subject: [PATCH] Add readme

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bae85ad
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Wayfarer
+> A simple TUI application to display Journey savefiles.
+
+
+## How to install
+
+Simply install it with cargo.
+
+```sh
+cargo install --git https://github.com/valeth/wayfarer
+```
+
+Make sure the path cargo installs to is in your system's `PATH`.
+
+```sh
+wayfarer tui <path-to-savefile>
+
+# or
+
+wayfarer show <path-to-savefile>
+```
+
+
+## TUI Keybindings
+
+| Key | Description                                         |
+|:---:| --------------------------------------------------- |
+| ESC | Return to "normal mode"                             |
+| q   | Quits the application                               |
+| o   | Open a new file                                     |
+| w   | Toggle file watcher mode (requires "watch" feature) |