diff --git a/README.md b/README.md index 540ae68..2409382 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ A simple nifty tool to build your mod in just one go! -## How to use +## How to install Simply `git pull` and run it. It's easy. @@ -14,6 +14,23 @@ wget https://raw.githubusercontent.com/Sayo-nika/autobuild.sh/master/autobuild.s ```` +## Using the CLI + +To start the script in interactive mode, just run `./autobuild.sh`. + +However, if you want to use arguments for non-interactive usage, like CIs, These are the available options + +``` +./autobuild.sh [-d | -h] + +Builds a mod by creating a build/ folder and compiles releases there. +When no arguments are present, the script starts in interactive mode. +However, for non-interactive usage, the following is accepted as a argument: + +-d The Directory of the mod to build. +-h Print this help dialogue. +``` + ## Contributing If you think you can make this better, send us a PR! We love you.