From 0c64d4d1add2a165faaf17e1676391b38187993c Mon Sep 17 00:00:00 2001
From: Ziver Koc <ziver@koc.se>
Date: Fri, 23 Sep 2016 15:51:40 +0200
Subject: [PATCH] Updated README.md file

---
 README.md                         |  57 +++++++++++++++++++++++++++++-
 Capture.JPG => screenshot_01.jpg  | Bin
 Capture2.JPG => screenshot_02.jpg | Bin
 Capture3.JPG => screenshot_03.jpg | Bin
 Capture4.JPG => screenshot_04.jpg | Bin
 5 files changed, 56 insertions(+), 1 deletion(-)
 mode change 100644 => 100755 README.md
 rename Capture.JPG => screenshot_01.jpg (100%)
 rename Capture2.JPG => screenshot_02.jpg (100%)
 rename Capture3.JPG => screenshot_03.jpg (100%)
 rename Capture4.JPG => screenshot_04.jpg (100%)

diff --git a/README.md b/README.md
old mode 100644
new mode 100755
index 9daeafb9..4aede5fc
--- a/README.md
+++ b/README.md
@@ -1 +1,56 @@
-test
+# Hal
+
+Hal is a home automation hub with sensor statistics with the functionality to share that data between friends. 
+It is developed to be very extensible so future Sensors and other input devices can be supported.
+ 
+Currently supported devices:
+- **Tellstick**
+    - NexaSelfLearning
+    - Oregon0x1A2D
+- **Raspberry Pi**, GPIO connected sensors
+
+
+The project is currently in alpha state, as such things will change and break.
+
+### Screenshots
+![](screenshot_01.jpg)
+
+![](screenshot_02.jpg)
+
+![](screenshot_03.jpg)
+
+![](screenshot_04.jpg)
+
+## Installing
+
+A step by step series of examples that tell you have to get a development env running
+
+Stay what the step will be
+
+```
+ant run
+```
+
+Check `hal.conf.example` for available configuration options.
+
+## Running the tests
+
+The current test coverage is greatly lacking, but to run the JUnit test cases run:
+
+```
+ant test
+```
+
+## Authors
+
+* **Daniel Collin**
+* **Ziver Koc**
+
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.txt](LICENSE.txt) file for details
+
+## Acknowledgments
+
+* Tellstick, for open-sourcing their code 
diff --git a/Capture.JPG b/screenshot_01.jpg
similarity index 100%
rename from Capture.JPG
rename to screenshot_01.jpg
diff --git a/Capture2.JPG b/screenshot_02.jpg
similarity index 100%
rename from Capture2.JPG
rename to screenshot_02.jpg
diff --git a/Capture3.JPG b/screenshot_03.jpg
similarity index 100%
rename from Capture3.JPG
rename to screenshot_03.jpg
diff --git a/Capture4.JPG b/screenshot_04.jpg
similarity index 100%
rename from Capture4.JPG
rename to screenshot_04.jpg