README.md in zxcvbn-0.1.5 vs README.md in zxcvbn-0.1.6
- old
+ new
@@ -1,10 +1,14 @@
# Zxcvbn
-This is a direct Ruby port of Dropbox's [zxcvbn.js][zxcvbn.js] JavaScript library.
-The intention is to provide all the same features and same results as close to the original JS fucntion would do.
+[](https://badge.fury.io/rb/zxcvbn)
+[](https://travis-ci.com/formigarafa/zxcvbn-rb)
+Ruby port of Dropbox's [zxcvbn.js][zxcvbn.js] JavaScript library running completely in Ruby (no need to load execjs or libv8).
+
+The intention is to provide an option 100% Ruby solution with all the same features and same results (or as close to the original JS function as possible).
+
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -64,9 +68,13 @@
"Add another word or two. Uncommon words are better."
]
}
}
```
+
+### Compatible with `zxcvbn-js` and `zxcvbn-ruby`
+
+This gem include a compatible interface so it can be used as a drop-in substitution for `zxcvbn-js` or `zxcvbn-ruby`. You can just call `Zxcvbn.test` or use `Zxcvbn::Tester.new` the same way as you would if you were using `zxcvbn-js` or `zxcvbn-ruby`.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.