diff options
| author | louie <lshprung@yahoo.com> | 2021-08-28 13:40:24 -0700 |
|---|---|---|
| committer | louie <lshprung@yahoo.com> | 2021-08-28 13:40:24 -0700 |
| commit | da841cd24abd28bf7038ed6b7cac968d0fb7acde (patch) | |
| tree | e6d58fa9ab2d41284f2f88afad225ba91ed2b0af | |
| parent | f15f0499fa2c5ef9a9f9eee58820366de53b170e (diff) | |
Created README
| -rw-r--r-- | .gitignore | 5 | ||||
| -rw-r--r-- | README.md | 17 | ||||
| -rwxr-xr-x | update_ungoogled_chromium.sh | 5 |
3 files changed, 25 insertions, 2 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..bc0cf7f --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +* +!.gitignore + +!README.md +!update-ungoogled-chromium.sh diff --git a/README.md b/README.md new file mode 100644 index 0000000..ffc584f --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +## Introduction + +**update-ungoogled-chromium** is a bash script that can help to automate installation and updating of [ungoogled-chromium](https://github.com/Eloston/ungoogled-chromium). The script parses the [atom feed](https://raw.githubusercontent.com/ungoogled-software/ungoogled-chromium-binaries/master/feed.xml) to check if a newer version of ungoogled-chromium is available, and prompts the user whether they would like to install it if there is. + +*Note: update-ungoogled-chromium sources contributor binaries, which are not necessarily reproducible. For more information, see the note [here](https://github.com/Eloston/ungoogled-chromium#downloads)* + +## Dependencies + +- bash +- curl +- xml2 + +## Supported Platforms + +Currently, update-ungoogled-chromium can target the following platforms: + +- Portable Linux 64-bit diff --git a/update_ungoogled_chromium.sh b/update_ungoogled_chromium.sh index 4443184..dec4925 100755 --- a/update_ungoogled_chromium.sh +++ b/update_ungoogled_chromium.sh @@ -32,9 +32,10 @@ fi # Print help message print_help() { - echo "Usage: $0 LINK [LOCATION]" + echo "Usage: $0 [LINK] [LOCATION]" echo - echo "LINK is the path for a symlink pointing to the ungoogled-chromium executable (ungoogled-chromium by default)" + echo "$0 is a bash script that can help to automate installation and updating of ungoogled-chromium" + echo "LINK is the path or desired path for a symlink pointing to the ungoogled-chromium executable. If LINK is not specified, it will be set to ungoogled-chromium by default" echo "LOCATION is the desired install location for ungoogled-chromium. It does not need to be specified unless installing ungoogled-chromium for the first time" } |