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 + +# or + +wayfarer show +``` + + +## 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) |