Permalink
Browse files

README and LICENSE updates

  • Loading branch information...
1 parent 2de187e commit 74287ff8bec33de052b1fee1685db65dd527848b @michaelklishin michaelklishin committed Nov 9, 2012
Showing with 22 additions and 10 deletions.
  1. +1 −0 LICENSE
  2. +21 −10 README.md
View
@@ -1,4 +1,5 @@
Copyright (c) 2010 – 2011 Jakub Šťastný aka Botanicus
+Copyright (c) 2011 – 2012 Michael S. Klishin <michael@defprotocol.org>
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
View
@@ -2,11 +2,9 @@
amq-protocol is an AMQP 0.9.1 serialization library for Ruby. It is not an
AMQP client: amq-protocol only handles serialization and deserialization.
-If you want to write your own AMQP client, this gem can help you with that.
-## How does amq-protocol relate to amqp gem, amq-client and libraries like bunny?
-
-See [this page about AMQP gems family](https://github.com/ruby-amqp/amq-client/blob/master/README.textile)
+If you want to write your own AMQP client, this gem will handle all the serialization
+needs for you, including RabbitMQ extensions to AMQP 0.9.1.
## Installation
@@ -23,11 +21,11 @@ Make sure you have Python, pip and the mako templating package installed:
amq-protocol uses RabbitMQ protocol code generation library that is in Python, so there is some
Python involved in the build.
-To regenerate `lib/amq/protocol/client.rb` from the source (`protocol.rb.pytemplate`), run
+To regenerate `lib/amq/protocol/client.rb` from the source (`codegen/*` files), run
./generate.rb
-To make changes, **do not edit client.rb directly**. Instead, edit `protocol.rb.pytemplate` and regenerate.
+To make changes, **do not edit client.rb directly**. Instead, edit the `codegen/protocol.rb.pytemplate` and regenerate.
To run tests, use
@@ -40,8 +38,21 @@ To run tests, use
amq-protocol is maintained by [Michael Klishin](https://github.com/michaelklishin).
-## Links
+## CI Status
+
+[![Build Status](https://secure.travis-ci.org/ruby-amqp/amq-protocol.png)](https://travis-ci.org/ruby-amqp/amq-protocol)
+
+
+## Development
+
+Please report any issues you may find to our [Issue tracker](http://github.com/ruby-amqp/amq-protocol/issues) on GitHub.
+
+
+## Mailing List
+
+Any questions you may have should be sent to the [Ruby AMQP mailing list](http://groups.google.com/group/ruby-amqp).
+
+
+## License
- * [Continous integration server](http://travis-ci.org/#!/ruby-amqp/amq-protocol)
- * [Ruby AMQP mailing list](http://groups.google.com/group/ruby-amqp)
- * [Issue tracker](http://github.com/ruby-amqp/amq-protocol/issues)
+MIT (see LICENSE in the repository root).

0 comments on commit 74287ff

Please sign in to comment.