diff --git a/README.md b/README.md index 427639b..6004249 100644 --- a/README.md +++ b/README.md @@ -19,16 +19,33 @@ These instructions will help you get a copy of Aurorium up and running on your l - [rust-analyzer extension](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) ### Installation + Install [`git`](https://git-scm.com/) to clone this repository to your local machine. Run following command in your designated folder: + ```bash git clone https://github.com/Revive101/Aurorium.git ``` ### Usage + To run the executable, use `cargo run` alternatively you can build it using `cargo build` or in release `cargo build --release`. +### Parameters + +You can provide the (built) executable with following parameters: + +``` + -v, --verbose Activate verbosity (Default: warn) + -r, --revision= Fetch from a revision string (Example V_r740872.Wizard_1_520) + -i, --ip= Override the default endpoint IP (Default: 0.0.0.0:12369) + -c, --concurrent_downloads= Override the count of concurrent downloads at once (Default: 8) + --max_requests= Change the amount of requests a user can send before getting rate-limited by the server + --reset_duration= Change the duration for the interval in which the rate-limit list get's cleared (In seconds) + -h, --help Prints help information +``` ## Contributing + We welcome contributions from the community! Whether you're an experienced developer or just getting started, there are many ways to contribute to Aurorium's development: Check out our [Contributing Guidelines](TODO) for detailed information on how to contribute. @@ -36,6 +53,7 @@ Fork the repository, make your changes, and submit a pull request. Report bugs or suggest new features by opening [issues](https://github.com/Revive101/Aurorium/issues). ## Community + Join the Revive101 community on [discord](https://discord.gg/sMFgyNRDDM) to connect with fellow Wizards, developers, and enthusiasts. ## License