Release 1.0.0

Signed-off-by: Ralph Niemitz <[email protected]>

README.md

@@ -1,2 +1,44 @@
-# SimpleRegistry
-A Java library for reading and editing the Windows registry
+# Description
+SimpleRegistry is pure Java library that grants you read and write access to the Windows registry.
+
+# Requirements
+- Java 8 or later
+- Windows Vista or later (XP and older systems are not supported)
+
+# Setup
+Just put the Java archive on your build path.
+
+# Example
+```java
+public static void main(String[] args) {
+
+	try {
+
+		// Creating Keys
+		Registry.setKey(Registry.HKEY_CURRENT_USER + "\\Software\\MyExampleSoftware");
+		Key mySoftwareKey = Registry.getKey(Registry.HKEY_CURRENT_USER + "\\Software\\MyExampleSoftware");
+		mySoftwareKey.setValue("myExampleValue", Value.Type.REG_SZ, '\0', "Hello World!");
+		mySoftwareKey.reload();
+		System.out.println(mySoftwareKey.getValueByName("myExampleValue"));
+
+		// Reading keys
+		Key key = Registry.getKey(Registry.HKEY_CURRENT_USER + "\\Software");
+
+		for(Key child : key.getChilds()) {
+
+			System.out.println(child.getName());
+		}
+
+		// Removing Keys
+		Registry.deleteKey(mySoftwareKey.getPath());
+
+	} catch(IOException exception) {
+
+		exception.printStackTrace();
+	}
+}
+```
+
+# Links
+See the [download page]()
+See the [online documentation]()