Update 'README.md'
This commit is contained in:
20
README.md
20
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`
|
||||||
Reference in New Issue
Block a user