Permalink
Browse files

write readme

  • Loading branch information...
1 parent ea79ae4 commit 66a3e86bd82eda69ecb2fdf61dd8ddd41fd750e6 @hsbt committed Mar 5, 2012
Showing with 26 additions and 4 deletions.
  1. +24 −2 README.md
  2. +2 −2 heroku_scale_scheduler.gemspec
View
@@ -1,6 +1,6 @@
# HerokuScaleScheduler
-TODO: Write a gem description
+HerokuScaleScheduler is schedule scale of heroku dynos/workers.
## Installation
@@ -18,7 +18,29 @@ Or install it yourself as:
## Usage
-TODO: Write usage instructions here
+1. run the folllow commands
+
+```
+$ bundle exec rails g heroku_scale_scheduler:install
+```
+
+2. write your scheduling configuration to config/heroku_ps.yml. notice: schedule time is must be 10 minutes periods.
+3. add Heroku scheduler addons.
+4. visit your Heroku scheduler dashboard, and added follow tasks
+
+<table>
+<tr><th>TASK</th><th>FREQUENCY<th></tr>
+<tr><td>rake heroku:scale:dynos</td><td>Every 10 minutes</td></tr>
+<tr><td>rake heroku:scale:workers</td><td>Every 10 minutes</td></tr>
+<table>
+
+5. add your heroku api key to Heroku env. example for
+
+```
+$ heroku config:add HEROKU_API_KEY=xxx --app example_app
+```
+
+6. push your app for heroku.
## Contributing
@@ -4,8 +4,8 @@ require File.expand_path('../lib/heroku_scale_scheduler/version', __FILE__)
Gem::Specification.new do |gem|
gem.authors = ["SHIBATA Hiroshi"]
gem.email = ["shibata.hiroshi@gmail.com"]
- gem.description = %q{TODO: Write a gem description}
- gem.summary = %q{TODO: Write a gem summary}
+ gem.description = "scaling scheduler for heroku dynos/workers"
+ gem.summary = "heroku_scale_scheduler is simple scaling scheduler for heroku dynos/workers."
gem.homepage = ""
gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

0 comments on commit 66a3e86

Please sign in to comment.