README.md in populus-0.0.1.pre3 vs README.md in populus-0.0.1
- old
+ new
@@ -1,8 +1,8 @@
# Populus
-TODO: Write a gem description
+[WIP][Will breaking change] Consul event handlers definition DSL
## Installation
Add this line to your application's Gemfile:
@@ -18,14 +18,34 @@
$ gem install populus
## Usage
-TODO: Write usage instructions here
+### Usages below are just a draft
+```ruby
+Populus.watch 'node' do
+ on_receive do |nodes|
+ if nodes.count < 10
+ logger.warn "nodes are too short!"
+ end
+ end
+end
+```
+
+```bash
+consul watch -type node "bundle exec populus accept sample.popl"
+```
+
+### TODOs
+
+* Deployment switching by node name
+* Condition phrase against JSON
+* Local/remote execution by specinfra
+
## Contributing
-1. Fork it ( https://github.com/[my-github-username]/populus/fork )
+1. Fork it ( https://github.com/udzura/populus/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request