README.md in propono-0.0.1 vs README.md in propono-0.1.0
- old
+ new
@@ -1,13 +1,11 @@
# Propono
[![Build Status](https://travis-ci.org/meducation/propono.png)](https://travis-ci.org/meducation/propono)
[![Dependencies](https://gemnasium.com/meducation/propono.png?travis)](https://gemnasium.com/meducation/propono)
[![Code Climate](https://codeclimate.com/github/meducation/propono.png)](https://codeclimate.com/github/meducation/propono)
-[![Coverage Status](https://coveralls.io/repos/meducation/propono/badge.png)](https://coveralls.io/r/meducation/propono)
-
## Installation
Add this line to your application's Gemfile:
gem 'propono'
@@ -17,9 +15,37 @@
gem 'propono', github: "meducation/propono"
And then execute:
$ bundle
+
+This script demonstrates usage:
+
+```ruby
+require 'propono'
+
+class Toy
+ def play
+ configure
+ make_fun_stuff_happen
+ end
+
+ private
+ def make_fun_stuff_happen
+ Propono.publish("jez-test-topic", "A test message")
+ Propono.subscribe_by_queue("jez-test-topic")
+ Propono.subscribe_by_post("jez-test-topic", 'http://example.com/endpoint')
+ end
+
+ def configure
+ Propono.config.access_key = '...'
+ Propono.config.secret_key = '...'
+ Propono.config.queue_region = 'eu-west-1'
+ end
+end
+
+Toy.new.play
+```
## Contributing
Firstly, thank you!! :heart::sparkling_heart::heart: