Improve tests and coumentation.

README.md

@@ -2,12 +2,22 @@
 
 > :warning: **Still under construction**
 
-simple i18n support that relies on standard go libraries
+Simple `i18n` support that relies on standard go libraries
 
 ## How to start?
 
-The i18n package mainly includes a set of methods for managing the data. Start by creating a new i18n instance.
+The `i18n` package mainly includes a set of methods for managing the data. Start by creating a `en.json` file.
+```bash
+{
+    "some": {
+        "awesome": {
+            "text": "Hello World!"
 
+        }
+    }
+}
+```
+Create a new `I18N` instance as follows.
 ```bash
 i18n := NewI18N().BindPath("./example/en.json")
 i18n, err := i18n.BindMainLocale("en")
@@ -21,7 +31,7 @@ if err != nil {
 }
 ```
 
-Once you setup the i18n instance, you must be able to lookup for messages.
+Once you setup the i18n instance, you should be able to lookup for messages.
 ```bash
 result, err := i18n.Lookup("some.awesome.text")
 if err != nil {
@@ -30,6 +40,59 @@ if err != nil {
 fmt.Println(result)
 ```
 
+The program should print `Hello World!`
+
+### Lookup for a specific locale
+
+```bash
+result, err := i18n.LookupWithLocale("en", "some.awesome.text")
+if err != nil {
+    ...
+}
+fmt.Println(result)
+```
+
+The program should print `Hello World!`
+
+### Lookup with arguments
+
+`i18n` relies on `fmt.Sprintf(...)` to apply replacements, so you should be able to use it as follows.
+
+Your `.json` file should look like this. 
+```bash
+{
+    "some": {
+        "awesome": {
+            "textWithArgs": "Hello %s!"
+        }
+    }
+}
+```
+
+Lookup for messages like this.
+```bash
+result, err := i18n.Lookup("some.awesome.textWithArgs", "i18n")
+if err != nil {
+    ...
+}
+fmt.Println(result)
+```
+
+The program should print `Hello i18n!`
+
+## JSON Format
+
+```bash
+{
+    "some": {
+        "awesome": {
+            "text": "Hello World!",
+            "textWithArgs": "Hello %s!"
+        }
+    }
+}
+```
+
 ## How to install?
 
 ```bash

i18n_test.go

@@ -5,8 +5,10 @@ import (
 )
 
 func TestLookupMessageFound(t *testing.T) {
+	var err error
+
 	i18n := NewI18N().BindPath("./example/en.json")
-	i18n, err := i18n.BindMainLocale("en")
+	i18n, err = i18n.BindMainLocale("en")
 	if err != nil {
 		t.Errorf("Shouldn't return error, got %v", err)
 	}
@@ -28,8 +30,10 @@ func TestLookupMessageFound(t *testing.T) {
 }
 
 func TestLookupMessageFoundWithArgs(t *testing.T) {
+	var err error
+
 	i18n := NewI18N().BindPath("./example/en.json")
-	i18n, err := i18n.BindMainLocale("en")
+	i18n, err = i18n.BindMainLocale("en")
 	if err != nil {
 		t.Errorf("Shouldn't return error, got %v", err)
 	}
@@ -51,8 +55,10 @@ func TestLookupMessageFoundWithArgs(t *testing.T) {
 }
 
 func TestLookupMessageNotFound(t *testing.T) {
+	var err error
+
 	i18n := NewI18N().BindPath("./example/en.json")
-	i18n, err := i18n.BindMainLocale("en")
+	i18n, err = i18n.BindMainLocale("en")
 	if err != nil {
 		t.Errorf("Shouldn't return error, got %v", err)
 	}
@@ -74,8 +80,10 @@ func TestLookupMessageNotFound(t *testing.T) {
 }
 
 func TestLookupMessageNotFoundMoreLevels(t *testing.T) {
+	var err error
+
 	i18n := NewI18N().BindPath("./example/en.json")
-	i18n, err := i18n.BindMainLocale("en")
+	i18n, err = i18n.BindMainLocale("en")
 	if err != nil {
 		t.Errorf("Shouldn't return error, got %v", err)
 	}