README.md in validates_cnpj-2.0.1 vs README.md in validates_cnpj-3.0.0
- old
+ new
@@ -1,8 +1,8 @@
# ValidatesCnpj
-[](http://badge.fury.io/rb/validates_cnpj) [](http://travis-ci.org/plribeiro3000/validates_cnpj) [](https://gemnasium.com/plribeiro3000/validates_cnpj) [](https://coveralls.io/r/plribeiro3000/validates_cnpj) [](https://codeclimate.com/github/plribeiro3000/validates_cnpj)
+[](http://badge.fury.io/rb/validates_cnpj) [](http://travis-ci.org/plribeiro3000/validates_cnpj) [](https://coveralls.io/r/plribeiro3000/validates_cnpj) [](https://codeclimate.com/github/plribeiro3000/validates_cnpj)
Validates cnpj and test it in a simple way
## Installation
@@ -21,17 +21,36 @@
## Usage
Just use as any other validator:
```ruby
-class User < ActiveRecord::Base
- validates :cnpj, :cnpj => true
+class Company < ActiveRecord::Base
+ validates :cnpj, cnpj: true
end
```
-## Notes
+To force the attribute to be masked pass option `mask`:
-It will load a macher to test automatically if the gem is below shoulda-matchers.
+```ruby
+class Company < ActiveRecord::Base
+ validates :cnpj, cnpj: { mask: true }
+end
+```
+
+## Testing
+
+Require the matcher:
+
+```ruby
+require 'validates_cnpj/require_a_valid_cnpj_matcher'
+```
+
+Use in your tests:
+
+```ruby
+it { is_expected.to require_a_valid_cnpj } # It will test the attribute :cnpj by default
+it { is_expected.to require_a_valid_cnpj(:id) }
+```
## Mantainers
[@plribeiro3000](https://github.com/plribeiro3000)
## Contributing
\ No newline at end of file