README.md in argon2-0.1.1 vs README.md in argon2-0.1.2
- old
+ new
@@ -1,14 +1,11 @@
# Ruby Argon2 Gem
This Ruby Gem provides FFI bindings, and a simplified interface, to the Argon2 algorithm. [Argon2](https://github.com/P-H-C/phc-winner-argon2) is the official winner of the Password Hashing Competition, a several year project to identify a successor to bcrypt/PBKDF/scrypt methods of securely storing passwords. This is an independant project and not official from the PHC team.
-*This gem is now considered a beta release* and at this point is not recommended for production use. The more detailed advice here, is that it is feature complete, and I do not intend on making backward breaking API changes without bumping the Gem version semantically. There is complete tests and documentation, and I'm working on a project to put this into production.
+This project is now considered stable.
-However, at this point, the reference C library that we pull in is under active development, ([including from myself](https://github.com/P-H-C/phc-winner-argon2/pulls?q=is%3Apr+author%3Atechnion)), and this binding isn't released grade until that is.
-
-
[](https://travis-ci.org/technion/ruby-argon2)
[](https://codeclimate.com/github/technion/ruby-argon2)
[](https://codeclimate.com/github/technion/ruby-argon2/coverage)
## Design
@@ -68,10 +65,14 @@
argon = Argon2::Password.new(t_cost: 2, m_cost: 16, secret: KEY)
myhash = argon.hash("A password")
Argon2::Password.verify_password("A password", myhash, KEY)
```
+## OSX 'El Capitan' Issues
+
+The default installation workflow has caused issues with a number of gems under this update. There is some excellent documentation on the issue and some workarounds in the [Jekyll Documentation](http://jekyllrb.com/docs/troubleshooting/#jekyll-amp-mac-os-x-1011).
+
## RubyDocs documentation
[The usual URL](http://www.rubydoc.info/gems/argon2) will provide detailed documentation.
## FAQ
@@ -94,9 +95,27 @@
## Contributing
Any form of contribution is appreciated, however, please note the design goals above and work within them.
If an issue is felt to be a security concern, please contact me privately on: technion@lolware.net. If required, you may encrypt with [my GPG key](https://lolware.net/technion-GPG-KEY).
+
+## Building locally/Tests
+
+To build the gem locally, you will need to checkout the submodule and build it manually:
+
+```shell
+git submodule update --init --recursive
+bundle install
+cd ext/argon2_wrap/
+make
+cd ../..
+```
+
+The test harness includes a property based test. To more strenuously perform this test, you can tune the iterations parameter:
+
+```shell
+TEST_CHECKS=10000 bundle exec rake test
+```
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).