README.md in xstream-0.0.0 vs README.md in xstream-0.1.0

@@ -1,9 +1,64 @@
-# xstream.rb
+# xstream.rb [![Latest Version][gem-shield]][gem-link] [![Build Status][build-image]][build-link] [![Yard Docs][docs-image]][docs-link] [![MIT licensed][license-image]][license-link] [![Gitter Chat][gitter-image]][gitter-link]
 
-Public key encryption system combining X25519 Diffie-Hellman with the STREAM construction
+[gem-shield]: https://badge.fury.io/rb/xstream.svg
+[gem-link]: https://rubygems.org/gems/xstream
+[build-image]: https://secure.travis-ci.org/miscreant/xstream.svg?branch=master
+[build-link]: http://travis-ci.org/miscreant/xstream
+[docs-image]: https://img.shields.io/badge/yard-docs-blue.svg
+[docs-link]: http://www.rubydoc.info/gems/xstream/0.0.0
+[license-image]: https://img.shields.io/badge/license-MIT/Apache2.0-blue.svg
+[license-link]: https://github.com/miscreant/xstream#license
+[gitter-image]: https://badges.gitter.im/badge.svg
+[gitter-link]: https://gitter.im/miscreant/Lobby
 
+**XSTREAM** (pronounced *"extreme!"*) is a public key encryption system combining
+X25519 Elliptic Curve Diffie-Hellman ([RFC 7748]) with the [STREAM] construction.
+
+The implementations in this repository are built on top of the
+[Miscreant] misuse-resistant symmetric encryption library, which provides
+the [AES-SIV] and [AES-PMAC-SIV] algorithms.
+
+[More information on XSTREAM](https://github.com/miscreant/xstream/wiki/XSTREAM)
+is available in the Wiki.
+
+[RFC 7748]: https://tools.ietf.org/html/rfc7748
+[STREAM]: https://github.com/miscreant/miscreant/wiki/STREAM
+[Miscreant]: https://github.com/miscreant/miscreant
+[AES-SIV]: https://github.com/miscreant/miscreant/wiki/AES-SIV
+[AES-PMAC-SIV]: https://github.com/miscreant/miscreant/wiki/AES-PMAC-SIV
+
+## Help and Discussion
+
+Have questions? Want to suggest a feature or change?
+
+* [Gitter]: web-based chat about miscreant projects including **miscreant.rb**
+* [Google Group]: join via web or email ([[e-mail]])
+
+[Gitter]: https://gitter.im/miscreant/Lobby
+[Google Group]: https://groups.google.com/forum/#!forum/miscreant-crypto
+[[e-mail]]: mailto:[e-mail]?subject=subscribe
+
+## Security Notice
+
+Though this library is written by cryptographic professionals, it has not
+undergone a thorough security audit, and cryptographic professionals are still
+humans that make mistakes.
+
+Use this library at your own risk.
+
+## Requirements
+
+This library is tested against the following MRI versions:
+
+- 2.2
+- 2.3
+- 2.4
+- 2.5
+
+Other Ruby versions may work, but are not officially supported.
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -16,13 +71,37 @@
 
 Or install it yourself as:
 
     $ gem install xstream
 
-## Usage
+## Documentation
 
-TODO: Write usage instructions here
+[Please see the XSTREAM Wiki](https://github.com/miscreant/xstream/wiki/Ruby-Documentation)
+for API documentation.
 
+[Yard documentation][docs-link] is also available.
+
+## Code of Conduct
+
+We abide by the [Contributor Covenant][cc] and ask that you do as well.
+
+For more information, please see [CODE_OF_CONDUCT.md].
+
+[cc]: https://contributor-covenant.org
+[CODE_OF_CONDUCT.md]: https://github.com/miscreant/xstream/blob/master/CODE_OF_CONDUCT.md
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/miscreant/xstream.
 
+## License
+
+Copyright (c) 2017 [The Miscreant Developers][AUTHORS].
+
+All XSTREAM libraries are licensed under either of:
+
+* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
+
+[AUTHORS]: https://github.com/miscreant/miscreant/blob/master/AUTHORS.md