README.md in rbnacl-5.0.0 vs README.md in rbnacl-6.0.0

- old
+ new

@@ -1,27 +1,28 @@ -![RbNaCl](https://raw.github.com/cryptosphere/rbnacl/master/images/logo.png) +![RbNaCl](https://raw.github.com/crypto-rb/rbnacl/master/images/logo.png) ====== [![Gem Version](https://badge.fury.io/rb/rbnacl.svg)](http://badge.fury.io/rb/rbnacl) -[![Build Status](https://travis-ci.org/cryptosphere/rbnacl.svg?branch=master)](https://travis-ci.org/cryptosphere/rbnacl) -[![Code Climate](https://codeclimate.com/github/cryptosphere/rbnacl.svg)](https://codeclimate.com/github/cryptosphere/rbnacl) -[![Coverage Status](https://coveralls.io/repos/cryptosphere/rbnacl/badge.svg?branch=master)](https://coveralls.io/r/cryptosphere/rbnacl) -[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/cryptosphere/rbnacl/blob/master/LICENSE.txt) +[![Build Status](https://travis-ci.org/crypto-rb/rbnacl.svg?branch=master)](https://travis-ci.org/crypto-rb/rbnacl) +[![Code Climate](https://codeclimate.com/github/crypto-rb/rbnacl.svg)](https://codeclimate.com/github/crypto-rb/rbnacl) +[![Coverage Status](https://coveralls.io/repos/crypto-rb/rbnacl/badge.svg?branch=master)](https://coveralls.io/r/crypto-rb/rbnacl) +[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/crypto-rb/rbnacl/blob/master/LICENSE.txt) +[![Gitter Chat](https://badges.gitter.im/badge.svg)](https://gitter.im/crypto-rb/Lobby) _NOTE: This is the 5.x **stable** branch of RbNaCl. For the 4.x **legacy** branch, please see:_ -https://github.com/cryptosphere/rbnacl/tree/4-x-stable +https://github.com/crypto-rb/rbnacl/tree/4-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 Rubidium Sodium Chloride. Need help with RbNaCl? Join the [RbNaCl Google Group][group]. -We're also on IRC at #cryptosphere on irc.freenode.net +We're also on IRC at #crypto-rb on irc.freenode.net [nacl]: http://nacl.cr.yp.to/ [djb]: http://cr.yp.to/djb.html [group]: http://groups.google.com/group/rbnacl @@ -54,19 +55,31 @@ ### Is it any good? [Yes.](http://news.ycombinator.com/item?id=3067434) +## Help and Discussion + +Have questions? Want to suggest a feature or change? Join a discussion group: + +* [Crypto.rb Gitter]: web-based chat about Ruby crypto projects including **RbNaCl**. +* [Crypto.rb Google Group]: join via web or email ([crypto-rb+subscribe@googlegroups.com]) + +[Crypto.rb Gitter]: https://gitter.im/crypto-rb/Lobby +[Crypto.rb Google Group]: https://groups.google.com/forum/#!forum/crypto-rb +[crypto-rb+subscribe@googlegroups.com]: mailto:crypto-rb+subscribe@googlegroups.com?subject=subscribe + ## Supported platforms You can use RbNaCl on platforms libsodium is supported (see below). This library aims to support and is [tested against][travis] the following Ruby versions: * Ruby 2.2.6+ * Ruby 2.3.0+ +* Ruby 2.4.2+ * 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, @@ -78,21 +91,18 @@ 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 +[travis]: http://travis-ci.org/crypto-rb/rbnacl ## Installation -Note: [Windows installation instructions are available](https://github.com/cryptosphere/rbnacl/wiki/Windows-Installation). +Note: [Windows installation instructions are available](https://github.com/crypto-rb/rbnacl/wiki/Windows-Installation). ### libsodium -**NOTE: Want to avoid the hassle of installing libsodium? Use the -[rbnacl-libsodium](https://github.com/cryptosphere/rbnacl-libsodium) gem** - To use RbNaCl, you will need to install libsodium: https://github.com/jedisct1/libsodium At least version `1.0.0` is required. @@ -151,17 +161,17 @@ Additional power-user features are available. Please see the Wiki for further information. [YARD API documentation][yard] is also available. -[wiki]: https://github.com/cryptosphere/rbnacl/wiki -[simplebox]: https://github.com/cryptosphere/rbnacl/wiki/SimpleBox -[secretkey]: https://github.com/cryptosphere/rbnacl/wiki/Secret-Key-Encryption -[publickey]: https://github.com/cryptosphere/rbnacl/wiki/Public-Key-Encryption -[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 +[wiki]: https://github.com/crypto-rb/rbnacl/wiki +[simplebox]: https://github.com/crypto-rb/rbnacl/wiki/SimpleBox +[secretkey]: https://github.com/crypto-rb/rbnacl/wiki/Secret-Key-Encryption +[publickey]: https://github.com/crypto-rb/rbnacl/wiki/Public-Key-Encryption +[signatures]: https://github.com/crypto-rb/rbnacl/wiki/Digital-Signatures +[macs]: https://github.com/crypto-rb/rbnacl/wiki/HMAC +[hashes]: https://github.com/crypto-rb/rbnacl/wiki/Hash-Functions [yard]: http://www.rubydoc.info/gems/rbnacl ## Learn More While NaCl has designed to be easier-than-usual to use for a crypto @@ -207,9 +217,9 @@ * Make your changes and send a pull request * If your changes look good, we'll merge 'em ## License -Copyright (c) 2012-2017 Tony Arcieri, Jonathan Stott. Distributed under the MIT License. +Copyright (c) 2012-2018 Tony Arcieri, Jonathan Stott. Distributed under the MIT License. See [LICENSE.txt] for further details. -[LICENSE.txt]: https://github.com/cryptosphere/rbnacl/blob/master/LICENSE.txt +[LICENSE.txt]: https://github.com/crypto-rb/rbnacl/blob/master/LICENSE.txt