Update 'README.md'

This commit is contained in:
2022-08-29 14:31:59 -07:00
parent 9132afe917
commit 9e90a18c6a

View File

@@ -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`