diff --git a/README.md b/README.md index 171c5c0..c5e525b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# (WIP) Microsoft Edge (Beta) Updater +# Microsoft Edge Updater An updater program which can install the latest available version of Microsoft Edge to non-Debian-based Linux distros. Currently this program can only update the Beta release of Microsoft Edge for amd64 architectures. @@ -6,12 +6,15 @@ Currently this program can only update the Beta release of Microsoft Edge for am ## Usage ``` Usage: updater [OPTION] -Microsoft Edge Updater (0.1.3) - An updater program which can install the latest available version of Microsoft Edge to non-Debian-based Linux distros. +Microsoft Edge Updater (0.1.4) - An updater program which can install the latest available version of Microsoft Edge to non-Debian-based Linux distros. DISCLAIMER: Currently this program can only update the Beta release of Microsoft Edge for amd64 architectures. Options: -nn, --no-notify Prevent notifications from being set after a session. + --mode= Set the mode of the program to be ran in. Default mode + occurs without this flag. + * debug - run program in debug mode. -y, --yes-all Assume yes to all yes/no decisions. -v, --version Print out the version of the script and exit. -h, --help Print this help message and exit @@ -19,8 +22,19 @@ Options: ## Information * Program Name - Microsoft Edge Updater -* Script Name - updater -* Version - 0.1.3 (Beta) -* Synopsis - update Microsoft Edge (Beta) to the latest release. +* Script Name - `updater` +* Version - 0.1.4 +* Synopsis - update Microsoft Edge (Beta) to the latest release. * Author(s) - Ethan Smith-Coss (No contact) +* Contributors - Robert Morrison, Documentation * License - GNU GPLv3+ + +## Documentation +For more in-depth documentation on `updater`, view the manpage in markdown form [here](https://robmc.duckdns.org/git/TheOnePath/Microsoft-Edge-Updater/src/branch/main/updater.1.md). +Alternatively you can view the manpage from your terminal by downloading the project. + +```bash + $ git clone https://robmc.duckdns.org/git/TheOnePath/Microsoft-Edge-Updater + $ cd Microsoft-Edge-Updater/ + $ man ./updater.1 +```