Added README

picandocodigo · Jan 3, 2013 · 413ee40 · 413ee40
1 parent 2dca2bb
commit 413ee40
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,20 @@
+# CiUY
+
+A gem to validate Uruguayan Identity Documents (Cedula de Identidad Uruguaya)
+
+https://rubygems.org/gems/ci_uy
+
+Install:
+
+`gem install ci_uy`
+
+Use:
+``` ruby
+fernando@hoth ~ $ irb
+1.9.3p194 :001 > require 'ci_uy'
+ => true 
+1.9.3p194 :002 > CiUY.validate_ci("1.111.111-1")
+ => true 
+1.9.3p194 :003 > CiUY.get_validation_digit("2222222")
+ => "2" 
+ ```