From 76daad9e841cd5b43d88358d06949cf7e369240e Mon Sep 17 00:00:00 2001
From: Nils <32552517+byReqz@users.noreply.github.com>
Date: Fri, 22 Jan 2021 22:07:39 +0000
Subject: [PATCH] Update README.md
---
README.md | 26 ++++++++++++++++++++++++++
1 file changed, 26 insertions(+)
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"``