README.md in zser-0.0.0 vs README.md in zser-0.0.1

@@ -1,36 +1,75 @@
-# Zser
+# zser.rb [![Latest Version][gem-shield]][gem-link] [![Build Status][build-image]][build-link] [![MIT licensed][license-image]][license-link]
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/zser`. To experiment with that code, run `bin/console` for an interactive prompt.
+[gem-shield]: https://badge.fury.io/rb/zser.svg
+[gem-link]: https://rubygems.org/gems/zser
+[build-image]: https://secure.travis-ci.org/zcred/zser.svg?branch=master
+[build-link]: http://travis-ci.org/zcred/zser
+[license-image]: https://img.shields.io/badge/license-MIT-blue.svg
+[license-link]: https://github.com/zcred/zser/blob/master/LICENSE.txt
 
-TODO: Delete this and the text above, and describe your gem
+Ruby implementation of **zser**: a security-oriented serialization format
+with novel authentication properties based on "Merkleized" data structures.
 
+For more information, see the [toplevel README.md].
+
+[toplevel README.md]: https://github.com/zcred/zser/blob/master/README.md
+
+## Help and Discussion
+
+Have questions? Want to suggest a feature or change?
+
+* [Gitter]: web-based chat about zcred projects including **zser**
+* [Google Group]: join via web or email ([[e-mail]])
+
+[Gitter]: https://gitter.im/zcred/Lobby
+[Google Group]: https://groups.google.com/forum/#!forum/zcred
+[[e-mail]]: mailto:[e-mail]
+
+## Requirements
+
+This library is tested against the following MRI versions:
+
+- 2.2
+- 2.3
+- 2.4
+
+Other Ruby versions may work, but are not officially supported.
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'zser'
+gem "zser"
 ```
 
 And then execute:
 
     $ bundle
 
 Or install it yourself as:
 
     $ gem install zser
 
-## Usage
+## API
 
-TODO: Write usage instructions here
+### Zser.parse
 
-## Development
+To parse a **zser** message, use the `Zser.parse` method:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+>> Zser.parse("\x15\x07\x02\x03\x55".b)
+=> {1=>{24=>42}}
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/tarcieri/zser.
+Bug reports and pull requests are welcome on GitHub at https://github.com/zcred/zser
 
+## Copyright
+
+Copyright (c) 2017 [The Zcred Developers][AUTHORS].
+See [LICENSE.txt] for further details.
+
+[AUTHORS]: https://github.com/zcred/zcred/blob/master/AUTHORS.md
+[LICENSE.txt]: https://github.com/zcred/zser/blob/master/LICENSE.txt