added readme

Ingwersaft · May 18, 2018 · 22969ba · 22969ba
1 parent 44cb0dd
commit 22969ba
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -12,3 +12,5 @@ gradle-app.setting
 
 # # Work around https://youtrack.jetbrains.com/issue/IDEA-116898
 # gradle/wrapper/gradle-wrapper.properties
+/.idea/
+/out/
diff --git a/README.md b/README.md
@@ -1,2 +1,17 @@
 # Shutdowner
 minimal windows shutdown web service - shutdown your windows system remotely
+
+The service is very basic: GET on `http://<host|localhost|ip>:28828`
+-> shutdown in 5s
+
+# install
+* download latest release or build it
+* copy/extact release at a place you like
+* run `Shutdowner-install.bat` and restart windows
+* open firewall on port 28828 if external lan use is required
+
+# uninstall
+* run `Shutdowner-uninstall.bat` and restart windows
+# build
+`./gradlew build createWindowsService`
+`gradlew.bat build createWindowsService`
-Original file line number
+Diff line change
@@ Expand Up / @@ -12,3 +12,5 @@ gradle-app.setting @@
     # # Work around https://youtrack.jetbrains.com/issue/IDEA-116898
     # gradle/wrapper/gradle-wrapper.properties
+    /.idea/
+    /out/