Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

give readme some love

  • Loading branch information...
commit bfee24f8b913ac11ed4474e38773576ec8bfd521 1 parent 949a24d
@rkh authored
Showing with 21 additions and 8 deletions.
  1. +21 −8 README.md
View
29 README.md
@@ -4,8 +4,24 @@ Sinatra::BigBand
BigBand is a stack of [Sinatra](http://sinatrarb.com) extensions, most of them developed as part of BigBand, but usable without,
each of available as a separate gem. All BigBand extensions follow the same release cycle.
-Note: The list below are libraries, that already have been extracted from the BigBand master branch. More will follow.
-With the release of BigBand 0.4.0 this branch will become the new master branch.
+Usage
+-----
+
+Simply replace `Sinatra::Base` with `Sinatra::BigBand` in your application.
+
+A simple example would be:
+
+ require 'sinatra/big_band'
+ class MyApp < Sinatra::BigBand
+ # ...
+ end
+
+Maybe you want all extensions except `Sinatra::Compass`?
+
+ require 'sinatra/big_band'
+ class MyApp < Sinatra::BigBand :except => :Compass
+ # ...
+ end
The BigBand Stack
-----------------
@@ -16,10 +32,9 @@ Sinatra Extensions
* [Sinatra::Compass](http://github.com/rkh/sinatra-compass) – Integrates the Compass stylesheet framework
* [Sinatra::ConfigFile](http://github.com/rkh/sinatra-config-file) – Adds YAML config file support
* [Sinatra::MoreServer](http://github.com/rkh/sinatra-more-server) – Adds support for more web servers to Sinatra::Base#run!
-* [Sinatra::Namespace](http://github.com/rkh/sinatra-more-server) – Adds namespaces, allows namespaces to have local helpers.
+* [Sinatra::Namespace](http://github.com/rkh/sinatra-namespace) – Adds namespaces, allows namespaces to have local helpers.
* [Sinatra::Reloader](http://github.com/rkh/sinatra-reloader) – Advanced and fast code reloader
* [Sinatra::Sugar](http://github.com/rkh/sinatra-sugar) – Extensions for Sinatra's standard methods, like #set or #register
-* [Sinatra::WebInspector](http://github.com/rkh/sinatra-web-inspector) – Allows you to inspect a running app
Sinatra tool integration:
@@ -41,15 +56,13 @@ Goals for 0.4.0
* Some sub-projects should work with MagLev and IronRuby (partial MacRuby support planned for later release)
* Ease to modify the stack
-Setup via gemcutter
--------------------
+Setup via gem
+-------------
Try:
gem install big_band
-Note: Currently this will only install BigBand 0.3.x, since 0.4 is not out yet.
-
Running the specs / Manual setup
--------------------------------
Please sign in to comment.
Something went wrong with that request. Please try again.