From ce4fdfe22f72daf66e16ba16a5352f8922bf5a38 Mon Sep 17 00:00:00 2001 From: Ralph Niemitz Date: Wed, 26 Jul 2017 16:25:11 +0200 Subject: [PATCH] Release 1.0.0 Signed-off-by: Ralph Niemitz --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 44 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2f042fb..297326f 100644 --- a/README.md +++ b/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]() \ No newline at end of file