README.md in x25519-1.0.6 vs README.md in x25519-1.0.7
- old
+ new
@@ -5,13 +5,13 @@
[build-image]: https://travis-ci.org/crypto-rb/x25519.svg?branch=master
[build-link]: https://travis-ci.org/crypto-rb/x25519
[appveyor-image]: https://ci.appveyor.com/api/projects/status/4s05bcae0mow85v1?svg=true
[appveyor-link]: https://ci.appveyor.com/project/tarcieri/x25519
[docs-image]: https://img.shields.io/badge/yard-docs-blue.svg
-[docs-link]: http://www.rubydoc.info/gems/x25519/1.0.5
-[license-image]: https://img.shields.io/badge/License-LGPL%20v3-blue.svg
-[license-link]: https://www.gnu.org/licenses/lgpl-3.0
+[docs-link]: http://www.rubydoc.info/gems/x25519/1.0.6
+[license-image]: https://img.shields.io/badge/License-LGPL%20v2.1-blue.svg
+[license-link]: https://www.gnu.org/licenses/lgpl-2.1
[gitter-image]: https://badges.gitter.im/badge.svg
[gitter-link]: https://gitter.im/crypto-rb/Lobby
An efficient public key cryptography library for Ruby providing key
exchange/agreement.
@@ -30,10 +30,40 @@
[RFC7748]: https://tools.ietf.org/html/rfc7748
[How to (pre-)compute a ladder]: https://eprint.iacr.org/2017/264
[rfc7748_precomputed]: https://github.com/armfazh/rfc7748_precomputed
[ed25519 gem]: https://github.com/crypto-rb/ed25519
+### Is it any good?
+
+[Yes.](http://news.ycombinator.com/item?id=3067434)
+
+### What is it useful for?
+
+X25519 is a key exchange/agreement algorithm generally used as a low-level
+building block in cryptographic protocols.
+
+### Can I use X25519 to encrypt things?
+
+Please use [RbNaCl::Box] or the (experimental) [XSTREAM] library if you would
+like to use X25519 for public-key encryption. Otherwise, the X25519 algorithm
+is not directly useful for encryption without a higher-level encryption protocol
+built on top of it.
+
+[RbNaCl::Box]: https://github.com/crypto-rb/rbnacl/wiki/Public-Key-Encryption
+[XSTREAM]: https://github.com/miscreant/xstream
+
+## 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 **x25519**.
+* [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
+
## Requirements
**x25519.rb** is supported on and tested against the following platforms:
* MRI 2.2, 2.3, 2.4, 2.5
@@ -258,10 +288,10 @@
## Copyright and License
Copyright (c) 2017-2018 Armando Faz, Tony Arcieri
This gem is available as open source under the terms of the
-GNU Lesser General Public License v3.0 ([LICENSE](https://www.gnu.org/licenses/lgpl-3.0.txt))
+GNU Lesser General Public License v2.1 ([LICENSE](https://www.gnu.org/licenses/lgpl-2.1.txt))
## Code of Conduct
Everyone interacting in the x25519.rb project’s codebases, issue trackers, chat
rooms and mailing lists is expected to follow the [code of conduct].