Initial commit.

1 files changed, 66 insertions, 3 deletions

diff --git a/README.md b/README.md
index bb12aac..c7d2109 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,67 @@
-valua
-=====
+##Valua - Validation for Lua
 
-A module for making chained validations in Lua. Create your objects, append your tests, use and reuse it!
+A module for making chained validations. Create your objects, append your tests, use and reuse it!
+
+Originally bundled with Sailor MVC Web Framework, now released as a separated module.
+  https://github.com/Etiene/sailor
+
+This module provides tools for validating values, very useful in forms, but also usable elsewhere. It works in appended chains. Create a new validation object and start chaining your test functions. If your value fails a test, it breaks the chain and does not evaluate the rest of it. It returns a boolean and an error string (nil when tests succeeded)
+
+####Usage
+Example 1 - Just create, chain and use:
+```lua
+valua:new().type("string").len(3,5)("test string!") -- false, "should have 3-5 characters"
+```
+Example 2 - Create, chain and later use it multiple times:
+```lua
+local reusable_validation = valua:new().type("string").len(3,5)
+reusable_validation("test string!") -- false, "should have 3-5 characters"
+reusable_validation("test!") -- true
+```
+
+####Current validation functions
+
+  * alnum() - 
+Checks if string is alfanumeric.
+  * boolean() - 
+Checks if value is a boolean.
+  * compare(another_value) - 
+Checks if value is equal to another value.
+  * contains(substr) - 
+Check if a string contains a substring.
+  * date() or date(format) -  
+Checks if a string is a valid date. Default format is UK (dd/mm/yyyy). Also checks for US and ISO formats.
+  * email() - 
+Checks if a string is a valid email address.
+  * empty() - 
+Checks if a value is empty.
+  * integer() - 
+Checks if a number is an integer;
+  * in_list(list) - 
+Checks if a value is inside an array.
+  * len(min,max) -
+Checks if a string's length is between min and max.
+  * match(pattern) -
+Checks if a string matches a given pattern.
+  * max(n) - 
+Checks if a number is equal or less than n.
+  * min(n) - 
+Checks if a number is equal or greater than n.
+  * not_empty() - 
+Checks if a value is not empty.
+  * no_white() - 
+Checks if a string contains no white spaces.
+  * number() - 
+Checks if a value is a number.
+  * string() - 
+Checks if a value is a string.
+  * type(t) -
+Checks if a value is of type t.
+
+
+
+Copyright (c) 2014 Etiene Dalcol
+
+http://etiene.net
+
+License: MIT