README.md in totoro-0.1.2 vs README.md in totoro-0.1.3
- old
+ new
@@ -1,39 +1,58 @@
-# Totoro
+# Totoro, a RabbitMQ Util
-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/totoro`. To experiment with that code, run `bin/console` for an interactive prompt.
+Totoro is a RabbitMQ util that focuses on samplify queue operation.
-TODO: Delete this and the text above, and describe your gem
-
## Installation
+#### Install gem
Add this line to your application's Gemfile:
```ruby
gem 'totoro'
```
And then execute:
$ bundle
-Or install it yourself as:
+#### Generate configuration file
+```
+rails g totoro:config
+```
- $ gem install totoro
+## Quick Start
-## Usage
+#### Enqueue
+```
+Totoro::Queue.enqueue('queue', payload)
+```
-TODO: Write usage instructions here
+#### Dequeue
+To create a dequeue daemon, first you need to create a worker
+```
+rails g totoro:wroker <worker_name> <queue_name>
+```
+after that, add business logic in the process method
+```
+module Worker
+ class WorkerClass
+ QUEUE = 'queue_name'
+ def process(payload, _metadata, _delivery_info)
+ # worker process
+ end
+ end
+end
+```
+finally, run the background deamon
+```
+bundle exec totoro worker_class
+```
-## Development
-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.
-
-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/[USERNAME]/totoro. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/blockchaintech-au/totoro. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).