From 7536d04c4440dcd57de82910627ab565d4fce0d1 Mon Sep 17 00:00:00 2001
From: edolganov <evgenij.dolganov@gmail.com>
Date: Sat, 19 Dec 2015 20:46:37 +0300
Subject: [PATCH] README.md

---
 README.md                                     | 115 ++++++++++++++++++
 .../java/examples/Ex1_Simple_map_props.java   |   2 +-
 2 files changed, 116 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2104665..3c52e11 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,117 @@
 # props4j
 Comfortable Properties for Java
+
+Simple and useful properties tools with no dependencies.
+
+## Cases
+### Props with auto convert values
+```java
+import base.props4j.impl.MapProps;
+
+MapProps props = new MapProps();
+props.putVal("key1", 1);
+props.putVal("key2", "val2");
+props.putVal("key3", true);
+
+String strVal_1 = props.strVal("key1"); //"1"
+long longVal_1 = props.longVal("key1"); //1L
+Boolean boolVal_1 = props.boolVal("key1"); //false
+```
+
+### Default values for empty keys or bad values
+```java
+int defVal =  props.intVal("unknown-key", 42); //42
+```
+
+### File props with updates check
+```java
+import base.props4j.impl.FileProps;
+import java.io.File;
+
+File file = new File("test.properties");
+writeToFile(file, "key1 = 1");
+
+FileProps props = new FileProps(file);
+int val = props.intVal("key1"); //1
+
+//update file
+writeToFile(file, "key1 = 2");
+
+Thread.sleep(...);
+
+int newVal = props.intVal("key1"); //2
+```
+
+### MultiProps for many sources
+```java
+import base.props4j.impl.FileProps;
+import base.props4j.impl.MultiProps;
+
+MultiProps props = new MultiProps();
+props.addSource(new FileProps(file1));
+props.addSource(new FileProps(file2));
+```
+
+### Enum for keys!
+```java
+import base.props4j.DefValKey;
+
+public enum Keys implements DefValKey {
+	
+	planets_in_solar_system(8),
+	is_frog_green(true),
+	myName("Evgeny"),
+	star_wars_episodes_count(999.999d),
+	...
+}
+
+
+MapProps props = new MapProps();
+int defVal = Keys.planets_in_solar_system.intFrom(props); //8
+		
+props.putVal(planets_in_solar_system, 9);
+int updatedVal = Keys.planets_in_solar_system.intFrom(props); //9
+```
+
+### Expressions ${...} in values
+```java
+props.putVal("url", "127.0.0.1");
+props.putVal("link1", "${url}/some1");
+props.putVal("link2", "${url}/some2");
+
+String link1 = props.strVal("link1"); // 127.0.0.1/some1
+String link2 = props.strVal("link2"); // 127.0.0.1/some2
+```
+
+## Code examples
+- [Example 1: Simple MapProps and basic get-put methods](https://github.com/edolganov/props4j/blob/master/props-common/src/test/java/examples/Ex1_Simple_map_props.java)
+- [Example 2: FileProps for file properties](https://github.com/edolganov/props4j/blob/master/props-common/src/test/java/examples/Ex2_File_props.java)
+- [Example 3: FileProps and file updated check](https://github.com/edolganov/props4j/blob/master/props-common/src/test/java/examples/Ex3_File_props_update.java)
+- [Example 4: MultiProps for many props sources](https://github.com/edolganov/props4j/blob/master/props-common/src/test/java/examples/Ex4_Multi_props.java)
+- [Example 5: Java Enums are best keys for props!](https://github.com/edolganov/props4j/blob/master/props-common/src/test/java/examples/Ex5_Enum_by_key.java)
+- [Example 6: Expressions ${...} in values](https://github.com/edolganov/props4j/blob/master/props-common/src/test/java/examples/Ex6_Expressions_in_vals.java)
+
+
+
+
+## Installation to your project
+**Java 8 is required** 
+(sources can easily be ported to Java 6 or 7 -- but I'm on Java 8 now :))
+
+### by Maven
+[via stackoverflow](http://stackoverflow.com/questions/20161602/loading-maven-dependencies-from-github)
+```xml
+<repository>
+    <id>jitpack.io</id>
+    <url>https://jitpack.io</url>
+</repository>
+
+<dependency>
+    <groupId>com.github.edolganov</groupId>
+    <artifactId>props4j</artifactId>
+    <version>1.0</version>
+</dependency>
+```
+
+### by Release build
+Download and add **props4j-1.0.jar** to your project's classpath
\ No newline at end of file
diff --git a/props-common/src/test/java/examples/Ex1_Simple_map_props.java b/props-common/src/test/java/examples/Ex1_Simple_map_props.java
index 64056ef..532fdfe 100644
--- a/props-common/src/test/java/examples/Ex1_Simple_map_props.java
+++ b/props-common/src/test/java/examples/Ex1_Simple_map_props.java
@@ -37,7 +37,7 @@ public static void main(String[] args) {
 		String strVal_1 = props.strVal("key1"); //"1"
 		long longVal_1 = props.longVal("key1"); //1L
 		Boolean boolVal_1 = props.boolVal("key1"); //false
-		int defVal=  props.intVal("unknown-key", 42); //no key in props
+		int defVal = props.intVal("unknown-key", 42); //no key in props
 		
 		
 		//print [1, 1, false, 42]