README.md in validates_host-0.2.0 vs README.md in validates_host-0.3.0
- old
+ new
@@ -1,8 +1,8 @@
-# ValidatesHost
+# ValidatesHost [![Build Status](https://secure.travis-ci.org/plribeiro3000/validates_host.png?branch=master)](http://travis-ci.org/plribeiro3000/validates_host)
-TODO: Write a gem description
+Rails gem to validate Host Related fields.
## Installation
Add this line to your application's Gemfile:
@@ -16,10 +16,26 @@
$ gem install validates_host
## Usage
-TODO: Write usage instructions here
+Lets say you have a model that you want to have valid host fields. Just add this to your model:
+
+```ruby
+class Server < ActiveRecord::Base
+ validates :domain_name, :domain_name => true
+ validates :host_name, :host_name => true
+ validates :ip, :ip => true
+end
+
+class Subnet < ActiveRecord::Base
+ validates :value, :subnet => true
+end
+```
+
+## Test
+
+This gem has builtin matchers for shoulda-matchers and remarkable.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)