aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEtiene <Etiene@users.noreply.github.com>2014-03-12 16:21:35 -0300
committerEtiene <Etiene@users.noreply.github.com>2014-03-12 16:21:35 -0300
commita3dd143468244464193b95320b35895f20fa46d7 (patch)
treee611a7520601d88905245a0e0638e02830ceb487 /README.md
parent5e3bfc6b80da45979ccda1f10b08f0a10623868b (diff)
downloadvalua-a3dd143468244464193b95320b35895f20fa46d7.tar.gz
valua-a3dd143468244464193b95320b35895f20fa46d7.tar.bz2
valua-a3dd143468244464193b95320b35895f20fa46d7.zip
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/README.md b/README.md
index c7d2109..f5c8873 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,12 @@ A module for making chained validations. Create your objects, append your tests,
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)
+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).
+
+Valua is also available through luarocks
+````
+luarocks install valua
+````
####Usage
Example 1 - Just create, chain and use:
@@ -64,4 +69,6 @@ Copyright (c) 2014 Etiene Dalcol
http://etiene.net
+http://twitter.com/MulherCerebro
+
License: MIT