Updating documentation

Paulo Henrique Ortolan · Paulo Henrique Ortolan · commit f54ff9d1fc45 · 2018-04-06T17:04:54.000-03:00
diff --git a/README.md b/README.md
@@ -1,3 +1,56 @@
-# Java10Examples
+# Java 10 Examples
 
-Java JEP286 examples
+This project shows some examples on how to use the JEP286, the Local-Variable Type Inference, implemented on Java Version 10.
+
+## Basic examples:
+
+It's possible to use on primitive types:
+
+```java
+var i = 10; // It's an int
+```
+
+Refer to `org.java10.examples.BasicExample` class.
+
+
+It's possible to use on Java API classes:
+
+```java
+var hello = "Hello!";
+```
+
+Refer to `org.java10.examples.ObjectExample` class.
+
+## Complex example:
+
+It's possible to build developed objects:
+
+```java
+var Product = new Product("Good Laptop", 1000f, 10f);
+```
+
+Refer to `org.java10.examples.ComplexObjectExample` class.
+
+## Adding behaviour
+
+It's possible to add a new method to existing class
+
+```java
+var modifiedProduct = new Product("An internet product", 8f, 0.5f) {
+    public float applyInternetPrice() {
+        return getPrice() - 1f + getTax();
+    }
+};
+```
+
+Refer to `org.java10.examples.ProductExample` class.
+
+## Mixing interfaces
+
+It's possible to mix interfaces.
+
+```java
+var seaplane = (Navigable & Flyer) Vehicle::create;
+```
+
+Refer to `org.java10.examples.MixinExample` class.
diff --git a/src/main/java/org/java10/examples/ObjectExample.java b/src/main/java/org/java10/examples/ObjectExample.java
@@ -7,7 +7,7 @@
 public class ObjectExample {
 
     public static void main(String[] args) {
-        var string = "This is a String";
+        var hello = "Hello! This is an inferred String!";
 
         var now = LocalDate.now();
 
@@ -25,14 +25,14 @@ public static void main(String[] args) {
         stringList.add("!");
 
         System.out.println("Printing a String: ");
-        System.out.println(string);
+        System.out.println(hello);
         System.out.println("\nPrinting a formatted LocalDate: ");
         System.out.println(now.format(formatter));
         System.out.println("\nPrinting a String List: ");
         System.out.println(stringList);
 
         System.out.println("\nPrinting the inferred classes: ");
-        System.out.println(string.getClass());
+        System.out.println(hello.getClass());
         System.out.println(now.getClass());
         System.out.println(formatter.getClass());
         System.out.println(stringList.getClass());
