README.md in status_cat-0.1.1 vs README.md in status_cat-5.0.0

- old
+ new

@@ -38,11 +38,11 @@ 5. Visit http://yourapp/status_cat in a browser for an HTML status report ## Configuration - All configuration should go in `config/initializers/status_cat.rb`. + General configuration should go in `config/initializers/status_cat.rb`. Status.configure do |config| config.authenticate_with do authenticate! @@ -59,10 +59,18 @@ config.from = 'ops@schrodingersbox.com' config.subject = "#{Rails.env.upcase} StatusCat Failure" config.enabled = [ :action_mailer, :active_record ] end + + Checker specific configuration should in the initializer it relates to, + so it will be kept in sync. i.e. `config/initializers/twilio.rb` + + Twilio.configure do |config| + config.account_sid = StatusCat::Checkers::Twilio.sid = ENV['TWILIO_SID'] + config.auth_token = StatusCat::Checkers::Twilio.auth_token = ENV['TWILIO_AUTH_TOKEN'] + end ## How To ### Configure Enabled Checkers @@ -137,11 +145,16 @@ Create or add to `config/initializers/status_cat.rb` StatusCat.configure do |config| config.layout = 'admin' end + +### Get Started Developing +1. `cp spec/dummy/config/passwords.yml.sample spec/dummy/config/passwords.yml` +2. `rake app:db:create app:db:migrate app:db:test:prepare` + ## Reference * [Getting Started with Engines](http://edgeguides.rubyonrails.org/engines.html) * [Testing Rails Engines With Rspec](http://whilefalse.net/2012/01/25/testing-rails-engines-rspec/) * [How do I write a Rails 3.1 engine controller test in rspec?](http://stackoverflow.com/questions/5200654/how-do-i-write-a-rails-3-1-engine-controller-test-in-rspec) @@ -155,18 +168,9 @@ ## History * Version 0.0.2 = Rails 3 compatible * Version 0.0.3 = Rails 4 compatible + * Version 5.0.0 = Rails 5 compatible -## TODO - * Add disk space checker with externally configurable limit - * Add Zencoder checker? - * Add NewRelic checker? - * Dynamically create rake tasks for each checker - - * Doc - * General checker concept - * Shared spec - * Env vars to configure services