diff --git a/README.md b/README.md index 9dc0a50..fc27df5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,28 @@ # stocheck quick and dirty smart value checker + +### features: +- sata/nvme support +- show smart info and self-check results + +# usage +Usage: stocheck (options)
+Options:
+ -h/--help -- show help
+ -u/--update -- update the script
+ +# installation +1. download the script:
+```bash +wget https://git.byreqz.de/byreqz/stocheck/raw/branch/main/stocheck.sh +``` +2. run it with
+`` +bash stocheck.sh +`` +or
+`` +chmod +x stockheck.sh && ./stocheck.sh +`` +3. optionally alias it
+``alias stocheck="~/stocheck.sh"``