From 9e90a18c6a30e1027d316b41f193db4443fc5dab Mon Sep 17 00:00:00 2001 From: dormedas Date: Mon, 29 Aug 2022 14:31:59 -0700 Subject: [PATCH] Update 'README.md' --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ae3047b..921605d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ -# town-of-us-updater +# Town of Us Updater +A tool to automatically install the **Town of Us R** mod for **Among Us**. + +## Features + +- Caches old builds to allow you to continue playing the mod in case of a breaking Among Us update +- GUI to select which build to play +- Auto-detection of Among Us install directory + +# Contributing + +Help. I have no standards. Just look at the code. + +## How to Build + +- [Install Rust](https://www.rust-lang.org/learn/get-started) +- Download repository +- Navigate to repository +- `cargo build` \ No newline at end of file