Create README.md

ciderapp · May 20, 2023 · f78af2c · f78af2c
1 parent 30b97ff
commit f78af2c
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,14 @@
+# Cider-NZXT
+An extremely simple Go app using Gin to control NZXT Kraken Z/Elite coolers with information from Cider.
+
+## Installation
+Download the latest executable from [Releases](https://github.com/ciderapp/Cider-NZXT/releases/latest)
+
+## Build Instructions
+Requires Go, get it from here: https://go.dev/dl/
+
+Download Dependencies:
+`go get -u`
+
+Build executable:
+`go build -ldflags "-s -w"`