README.md in rbnacl-3.4.0 vs README.md in rbnacl-4.0.0.pre
- old
+ new
@@ -4,10 +4,15 @@
[](https://travis-ci.org/cryptosphere/rbnacl)
[](https://codeclimate.com/github/cryptosphere/rbnacl)
[](https://coveralls.io/r/cryptosphere/rbnacl)
[](https://github.com/cryptosphere/rbnacl/blob/master/LICENSE.txt)
+_NOTE: This is the 4.x **development** branch of RbNaCl. For the 3.x **stable**
+branch, please see:_
+
+https://github.com/cryptosphere/rbnacl/tree/3-x-stable
+
A Ruby binding to the state-of-the-art [Networking and Cryptography][nacl]
library by [Daniel J. Bernstein][djb]. This is **NOT** Google Native Client.
This is a crypto library.
On a completely unrelated topic, RbNaCl is also the empirical formula for
@@ -51,16 +56,34 @@
[Yes.](http://news.ycombinator.com/item?id=3067434)
## Supported platforms
-You can use RbNaCl anywhere you can get libsodium installed (see below).
-RbNaCl is continuously integration tested on the following Ruby VMs:
+You can use RbNaCl on platforms libsodium is supported (see below).
-* MRI 2.0, 2.1, 2.2, 2.3
-* JRuby 1.7, 9000
+This library aims to support and is [tested against][travis] the following Ruby
+versions:
+* Ruby 2.2.6+
+* Ruby 2.3.0+
+* JRuby 9.1.6.0+
+
+If something doesn't work on one of these versions, it's a bug.
+
+This library may inadvertently work (or seem to work) on other Ruby versions,
+however support will only be provided for the versions listed above.
+
+If you would like this library to support another Ruby version or
+implementation, you may volunteer to be a maintainer. Being a maintainer
+entails making sure all tests run and pass on that implementation. When
+something breaks on your implementation, you will be responsible for providing
+patches in a timely fashion. If critical issues for a particular implementation
+exist at the time of a major release, support for that Ruby version may be
+dropped.
+
+[travis]: http://travis-ci.org/cryptosphere/rbnacl
+
## Installation
Note: [Windows installation instructions are available](https://github.com/cryptosphere/rbnacl/wiki/Windows-Installation).
### libsodium
@@ -70,11 +93,11 @@
To use RbNaCl, you will need to install libsodium:
https://github.com/jedisct1/libsodium
-At least version `1.0.0` is recommended.
+At least version `1.0.0` is required.
For OS X users, libsodium is available via homebrew and can be installed with:
brew install libsodium
@@ -137,23 +160,10 @@
[signatures]: https://github.com/cryptosphere/rbnacl/wiki/Digital-Signatures
[macs]: https://github.com/cryptosphere/rbnacl/wiki/Authenticators
[hashes]: https://github.com/cryptosphere/rbnacl/wiki/Hash-Functions
[rdoc]: http://rubydoc.info/github/cryptosphere/rbnacl/master/frames
-## Reporting Security Problems
-
-If you have discovered a bug in RbNaCl of a sensitive nature, i.e.
-one which can compromise the security of RbNaCl users, you can
-report it securely by sending a GPG encrypted message. Please use
-the following key:
-
-https://raw.github.com/cryptosphere/rbnacl/master/bascule.asc
-
-The key fingerprint is (or should be):
-
-`9148 85A2 6242 1628 B6AA AB45 4CB9 B3D0 BACC 8B71`
-
## Learn More
While NaCl has designed to be easier-than-usual to use for a crypto
library, cryptography is an incredibly difficult subject and it's
always helpful to know as much as you can about it before applying
@@ -161,9 +171,10 @@
Bernstein, has published a number of papers about NaCl. If you are
interested in learning more about how NaCl works, it's recommended
that you read them:
* [Cryptography in NaCl](http://cr.yp.to/highspeed/naclcrypto-20090310.pdf)
+* [Salsa20 Design](https://cr.yp.to/snuffle/design.pdf)
* [Curve25519: new Diffie-Hellman speed records](http://cr.yp.to/ecdh/curve25519-20060209.pdf)
* [Ed25519: High-speed high-security signatures](http://ed25519.cr.yp.to/ed25519-20110926.pdf)
For more information on libsodium, please check out the
[Introducing Sodium blog post](http://labs.umbrella.com/2013/03/06/announcing-sodium-a-new-cryptographic-library/)