README.md in best_boy-0.0.3 vs README.md in best_boy-0.1.0
- old
+ new
@@ -25,10 +25,24 @@
Generate the BestBoyEvent table migration
rails g best_boy
+This will install following files into your application
+
+ config/initializers/best_boy.rb
+
+ db_migrate/create_best_boy_events_table.rb
+
+ public/javascripts/bootstrap_datepicker.js
+
+ public/stylesheets/bootstrap.css
+
+ public/stylesheets/bootstrap_datepicker.css
+
+See usage section for version information.
+
Run the migration
rake db:migrate
@@ -44,10 +58,11 @@
In controller context:
best_boy_event object, event
This will log custom events for a object and a event phrase.
+
If no Object is given, it will raise an exception as well as if no event is provided.
BestBoyEvent table
------------------
@@ -59,10 +74,29 @@
t.datetime "created_at" # creation timestamp
Getting BestBoyEvents
---------------------
-The table is namespaced, so you can access for statistics maybe with BestBoy::BestBoyEvent.where...
+BestBoy comes with an admin interface, largely configurable to fit right into your existing application.
+
+Following configurations can be done:
+
+ config.orm "symbole" # default: :active_record # for now only active_record is supported
+ config.base_controller "String" # default: "ApplicationController" # declare with Controller should be inherited
+ config.before_filter "comma separated symbols" # default: nil # declare before_filter to use inherited before_filters in admin section
+ config.skip_before_filter "comma separated symbols" # default: nil # declare skip_before_filter to skip inherited before_filters in admin section
+ config.custom_redirect "relative path as String" # default: nil # set a path to return back to your existing backend
+
+After installation you can access it through:
+
+ <your application path>/best_boy_admin
+
+
+Used gems and resource
+----------------------
+[Twitter Bootstrap](http://twitter.github.com/bootstrap/) in its version 2.0.4
+
+[Stefan Petre](http://www.eyecon.ro/bootstrap-datepicker) for Datepicker in Twitter Bootstrap style
Thanks
------
Big thanks to each contributor on Impressionist. This gem helped me a long way to get here in modelling and creating a gem.
\ No newline at end of file