twitter-bootstrap-rails 2.2.8 → 4.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95c5367e90ff42aa6e3e6f34f994dfe7b5bf3385
+  data.tar.gz: 94de97bcb6dc03f1c2cfd67a4f0500816cf0ea79
+SHA512:
+  metadata.gz: a00ee57e25ff5b706d2075b0226f101eb4932001ec4f8dc088e488c99ac3c9d3ff27e4a4e51308ea0c2f8b809fd76621abb05630719ce103f39a9f3dc8e864cc
+  data.tar.gz: 650348b073474697a89bd68085524cad957b364c146e91d4da876d1b579707c79636b96a2f803602a72926e6c79ad855a5454dfb6e29a8e8946f2b6567c765f7

data/README.md

@@ -1,50 +1,42 @@
-# Twitter Bootstrap for Rails 3.1 Asset Pipeline
-Bootstrap is a toolkit from Twitter designed to kickstart development of webapps and sites. It includes base CSS and HTML for typography, forms, buttons, tables, grids, navigation, and more.
+# Twitter Bootstrap for Rails 5 and Rails 4 Asset Pipeline
 
-twitter-bootstrap-rails project integrates Bootstrap CSS toolkit for Rails 3.1 Asset Pipeline (Rails 3.2 supported)
+Bootstrap is a toolkit from Twitter designed to kickstart development of web apps and sites. It includes base CSS and HTML for typography, forms, buttons, tables, grids, navigation, and more.
 
-[![Gem Version](https://badge.fury.io/rb/twitter-bootstrap-rails.png)][gem]
-[![Build Status](https://secure.travis-ci.org/seyhunak/twitter-bootstrap-rails.png?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/seyhunak/twitter-bootstrap-rails.png?travis)][gemnasium]
-[![Code Climate](https://codeclimate.com/github/seyhunak/twitter-bootstrap-rails.png)][codeclimate]
-[![Coverage Status](https://coveralls.io/repos/seyhunak/twitter-bootstrap-rails/badge.png?branch=master)][coveralls]
+twitter-bootstrap-rails project integrates Bootstrap CSS toolkit for Rails Asset Pipeline (Rails 4, 3.x versions are supported)
 
-[gem]: https://rubygems.org/gems/twitter-bootstrap-rails
-[travis]: http://travis-ci.org/seyhunak/twitter-bootstrap-rails
-[gemnasium]: https://gemnasium.com/seyhunak/twitter-bootstrap-rails
-[codeclimate]: https://codeclimate.com/github/seyhunak/twitter-bootstrap-rails
-[coveralls]: https://coveralls.io/r/seyhunak/twitter-bootstrap-rails
+[![Gem Version](https://badge.fury.io/rb/twitter-bootstrap-rails.svg)](http://badge.fury.io/rb/twitter-bootstrap-rails)
+[![Dependency Status](https://gemnasium.com/seyhunak/twitter-bootstrap-rails.svg?travis)](https://gemnasium.com/seyhunak/twitter-bootstrap-rails?travis)
+[![Code Climate](https://codeclimate.com/github/seyhunak/twitter-bootstrap-rails/badges/gpa.svg)](https://codeclimate.com/github/seyhunak/twitter-bootstrap-rails?branch=master)
+[![Coverage Status](https://coveralls.io/repos/seyhunak/twitter-bootstrap-rails/badge.png?branch=master)](https://coveralls.io/repos/seyhunak/twitter-bootstrap-rails/badge.png?branch=master)
+[![GitHub stars](https://img.shields.io/github/stars/seyhunak/twitter-bootstrap-rails.svg)](https://github.com/seyhunak/twitter-bootstrap-rails/stargazers)
+[![GitHub forks](https://img.shields.io/github/forks/seyhunak/twitter-bootstrap-rails.svg)](https://github.com/seyhunak/twitter-bootstrap-rails/network)
+[![GitHub issues](https://img.shields.io/github/issues/seyhunak/twitter-bootstrap-rails.svg)](https://github.com/seyhunak/twitter-bootstrap-rails/issues)
 
 ## Screencasts
 #### Installing twitter-bootstrap-rails, generators, usage and more
 <img width="180" height="35" src="http://oi49.tinypic.com/s5wn05.jpg"></img>
 
-Screencasts provided by <a href="http://railscasts.com">Railscasts</a> (Ryan Bates)
+Screencasts provided by <a href="http://railscasts.com">RailsCasts</a> (Ryan Bates)
 
 [Twitter Bootstrap Basics](http://railscasts.com/episodes/328-twitter-bootstrap-basics "Twitter Bootstrap Basics")
-in this episode you will learn how to include Twitter Bootstrap into Rails application with the twitter-bootstrap-rails gem.
+in this episode you will learn how to include Bootstrap into Rails application with the twitter-bootstrap-rails gem.
 
 [More on Twitter Bootstrap](http://railscasts.com/episodes/329-more-on-twitter-bootstrap "More on Twitter Bootstrap")
-in this episode continues on the Twitter Bootstrap project showing how to display flash messages, add form validations with SimpleForm, customize layout with variables, and switch to using Sass.
+in this episode continues on the Bootstrap project showing how to display flash messages, add form validations with SimpleForm, customise layout with variables, and switch to using Sass.
 (Note: This episode is pro episode)
 
-
-## Example Application
-An example application is available at [toadkicker/teststrap](https://github.com/toadkicker/teststrap). You can view it running on heroku [here.](http://teststrap.herokuapp.com/) Contributions welcome.
-
-
 ## Installing the Gem
 
-The [Twitter Bootstrap Rails gem](http://rubygems.org/gems/twitter-bootstrap-rails) can provide the Twitter Bootstrap stylesheets in two ways.
+The [Twitter Bootstrap Rails gem](http://rubygems.org/gems/twitter-bootstrap-rails) can provide the Bootstrap stylesheets in two ways.
 
-The plain CSS way is how Twitter Bootstrap is provided on [the official website](http://twitter.github.com/bootstrap/).
+The plain CSS way is how Bootstrap is provided on [the official website](http://twbs.github.io/bootstrap/).
 
-The [Less](http://lesscss.org/) way provides more customisation options, like changing theme colors, and provides useful Less mixins for your code, but requires the
+The [Less](http://lesscss.org/) way provides more customisation options, like changing theme colors and provides useful Less mixins for your code, but requires the
 Less gem and the Ruby Racer Javascript runtime (not available on Microsoft Windows).
 
 ### Installing the Less stylesheets
 
-To use Less stylesheets, you'll need the [less-rails gem](http://rubygems.org/gems/less-rails), and one of [Javascript runtimes supported by CommonJS](https://github.com/cowboyd/commonjs.rb#supported-runtimes).
+To use Less stylesheets, you'll need the [less-rails gem](http://rubygems.org/gems/less-rails), and one of [JavaScript runtimes supported by CommonJS](https://github.com/cowboyd/commonjs.rb#supported-runtimes).
 
 Include these lines in the Gemfile to install the gems from [RubyGems.org](http://rubygems.org):
 
@@ -68,6 +60,10 @@ Then run the bootstrap generator to add Bootstrap includes into your assets:
 
     rails generate bootstrap:install less
 
+If you need to skip coffeescript replacement into app generators, use:
+
+    rails generate bootstrap:install --no-coffeescript
+
 ### Installing the CSS stylesheets
 
 If you don't need to customize the stylesheets using Less, the only gem you need is the `twitter-bootstrap-rails` gem:
@@ -82,31 +78,19 @@ After running `bundle install`, run the generator:
 
 ## Generating layouts and views
 
-You can run following generators to get started with Twitter Bootstrap quickly.
+You can run following generators to get started with Bootstrap quickly.
 
 
-Layout (generates Twitter Bootstrap compatible layout) - (Haml and Slim supported)
+Layout (generates Bootstrap compatible layout) - (Haml and Slim supported)
 
 
 Usage:
 
 
-    rails g bootstrap:layout [LAYOUT_NAME] [*fixed or fluid]
-
-
-Example of a fixed layout:
-
+    rails g bootstrap:layout [LAYOUT_NAME]
 
-    rails g bootstrap:layout application fixed
 
-
-Example of a responsive layout:
-
-
-    rails g bootstrap:layout application fluid
-
-
-Themed (generates Twitter Bootstrap compatible scaffold views.) - (Haml and Slim supported)
+Themed (generates Bootstrap compatible scaffold views.) - (Haml and Slim supported)
 
 
 Usage:
@@ -142,33 +126,65 @@ You have to require Bootstrap LESS (bootstrap_and_overrides.css.less) in your ap
 
 To use individual components from bootstrap, your bootstrap_and_overrides.less could look like this:
 
-```css
-@import "twitter/bootstrap/reset.less";
+```less
+// Core variables and mixins
 @import "twitter/bootstrap/variables.less";
 @import "twitter/bootstrap/mixins.less";
+
+// Reset and dependencies
+@import "twitter/bootstrap/normalize.less";
+@import "twitter/bootstrap/print.less";
+//@import "twitter/bootstrap/glyphicons.less"; // Excludes glyphicons
+
+// Core CSS
 @import "twitter/bootstrap/scaffolding.less";
-@import "twitter/bootstrap/grid.less";
-@import "twitter/bootstrap/layouts.less";
 @import "twitter/bootstrap/type.less";
+@import "twitter/bootstrap/code.less";
+@import "twitter/bootstrap/grid.less";
+@import "twitter/bootstrap/tables.less";
 @import "twitter/bootstrap/forms.less";
-@import "twitter/bootstrap/wells.less";
-@import "twitter/bootstrap/component-animations.less";
 @import "twitter/bootstrap/buttons.less";
-@import "twitter/bootstrap/close.less";
+
+// Components
+@import "twitter/bootstrap/component-animations.less";
+@import "twitter/bootstrap/dropdowns.less";
+@import "twitter/bootstrap/button-groups.less";
+@import "twitter/bootstrap/input-groups.less";
 @import "twitter/bootstrap/navs.less";
 @import "twitter/bootstrap/navbar.less";
-@import "twitter/bootstrap/labels-badges.less";
-@import "twitter/bootstrap/hero-unit.less";
+@import "twitter/bootstrap/breadcrumbs.less";
+@import "twitter/bootstrap/pagination.less";
+@import "twitter/bootstrap/pager.less";
+@import "twitter/bootstrap/labels.less";
+@import "twitter/bootstrap/badges.less";
+@import "twitter/bootstrap/jumbotron.less";
+@import "twitter/bootstrap/thumbnails.less";
+@import "twitter/bootstrap/alerts.less";
+@import "twitter/bootstrap/progress-bars.less";
+@import "twitter/bootstrap/media.less";
+@import "twitter/bootstrap/list-group.less";
+@import "twitter/bootstrap/panels.less";
+@import "twitter/bootstrap/responsive-embed.less";
+@import "twitter/bootstrap/wells.less";
+@import "twitter/bootstrap/close.less";
+
+// Components w/ JavaScript
+@import "twitter/bootstrap/modals.less";
+@import "twitter/bootstrap/tooltip.less";
+@import "twitter/bootstrap/popovers.less";
+@import "twitter/bootstrap/carousel.less";
+
+// Utility classes
 @import "twitter/bootstrap/utilities.less";
-@import "twitter/bootstrap/responsive";
+@import "twitter/bootstrap/responsive-utilities.less";
 ```
 
 If you'd like to alter Bootstrap's own variables, or define your LESS
 styles inheriting Bootstrap's mixins, you can do so inside bootstrap_and_overrides.css.less:
 
 
-```css
-@linkColor: #ff0000;
+```less
+@link-color: #ff0000;
 ```
 
 ### SASS
@@ -185,50 +201,28 @@ If this is the case, you **must** use @import instead of `*=` in your manifest f
 
 ### Icons
 
-By default, this gem overrides standard Bootstraps's Glyphicons with Font Awesome (http://fortawesome.github.com/Font-Awesome/).
+By default, this gem (when using less generator) won't enable standard Bootstraps's Glyphicons.
 
-This should appear inside _bootstrap_and_overrides *(based on you twitter-bootstrap-rails version)*
+If you would like to restore the default Glyphicons, inside the generated `bootstrap_and_overrides.css.less` uncomment these lines:
 
-**From 2.2.7**
-
-```css
-// Font Awesome
-@fontAwesomeEotPath: asset-url("fontawesome-webfont.eot");
-@fontAwesomeEotPath_iefix: asset-url("fontawesome-webfont.eot?#iefix");
-@fontAwesomeWoffPath: asset-url("fontawesome-webfont.woff");
-@fontAwesomeTtfPath: asset-url("fontawesome-webfont.ttf");
-@fontAwesomeSvgPath: asset-url("fontawesome-webfont.svg#fontawesomeregular");
-@import "fontawesome/font-awesome";
+```less
+// Glyphicons are not required by default, uncomment the following lines to enable them.
+@glyphiconsEotPath: font-url("glyphicons-halflings-regular.eot");
+@glyphiconsEotPath_iefix: font-url("glyphicons-halflings-regular.eot?#iefix");
+@glyphiconsWoffPath: font-url("glyphicons-halflings-regular.woff");
+@glyphiconsTtfPath: font-url("glyphicons-halflings-regular.ttf");
+@glyphiconsSvgPath: font-url("glyphicons-halflings-regular.svg#glyphicons_halflingsregular");
+
+@import "twitter/bootstrap/glyphicons.less";
 ```
 
-**Before 2.2.7**
-
-```css
-// Font Awesome
-@fontAwesomeEotPath: "/assets/fontawesome-webfont.eot";
-@fontAwesomeEotPath_iefix: "/assets/fontawesome-webfont.eot?#iefix";
-@fontAwesomeWoffPath: "/assets/fontawesome-webfont.woff";
-@fontAwesomeTtfPath: "/assets/fontawesome-webfont.ttf";
-@fontAwesomeSvgPath: "/assets/fontawesome-webfont.svg#fontawesomeregular";
-@import "fontawesome";
-```
+This gem was used to bundle the excellent [Font-Awesome](http://fortawesome.github.io/Font-Awesome/) library.
+However that was another maintenance effort that is not worth to do here.
 
-If you would like to restore the default Glyphicons, inside the _bootstrap_and_overrides.css.less_ remove the FontAwesome declaration and uncomment the line:
+For Rails projects that need it there is the [font-awesome-rails gem](https://github.com/bokmann/font-awesome-rails) that
+provides same functionality that this gems was used to provide and it also have some other interesting features (e.g. view helpers).
 
-```less
-// Font Awesome
-// @fontAwesomeEotPath: asset-url("fontawesome-webfont.eot");
-// @fontAwesomeEotPath_iefix: asset-url("fontawesome-webfont.eot?#iefix");
-// @fontAwesomeWoffPath: asset-url("fontawesome-webfont.woff");
-// @fontAwesomeTtfPath: asset-url("fontawesome-webfont.ttf");
-// @fontAwesomeSvgPath: asset-url("fontawesome-webfont.svg#fontawesomeregular");
-// @import "fontawesome/font-awesome";
-
-// Glyphicons
-@import "twitter/bootstrap/sprites.less";
-```
-
-## Using Javascripts
+## Using JavaScript
 
 Require Bootstrap JS (bootstrap.js) in your application.js
 
@@ -236,7 +230,7 @@ Require Bootstrap JS (bootstrap.js) in your application.js
 //= require twitter/bootstrap
 
 $(function(){
-  /* Your javascripts goes here... */
+  /* Your JavaScript goes here... */
 });
 ```
 
@@ -245,18 +239,18 @@ If you want to customize what is loaded, your application.js would look somethin
 ```js
 #= require jquery
 #= require jquery_ujs
-#= require twitter/bootstrap/bootstrap-transition
-#= require twitter/bootstrap/bootstrap-alert
-#= require twitter/bootstrap/bootstrap-modal
-#= require twitter/bootstrap/bootstrap-button
-#= require twitter/bootstrap/bootstrap-collapse
+#= require twitter/bootstrap/transition
+#= require twitter/bootstrap/alert
+#= require twitter/bootstrap/modal
+#= require twitter/bootstrap/button
+#= require twitter/bootstrap/collapse
 ```
 
 ...and so on for each bootstrap js component.
 
-## Using Coffeescript (optionally)
+## Using CoffeeScript (optionally)
 
-Using Twitter Bootstrap with the CoffeeScript is easy.
+Using Bootstrap with the CoffeeScript is easy.
 twitter-bootstrap-rails generates a "bootstrap.js.coffee" file for you
 to /app/assets/javascripts/ folder.
 
@@ -270,22 +264,23 @@ jQuery ->
 
 ### Modal Helper
 You can create modals easily using the following example. The header, body, and footer all accept content_tag or plain html.
-The href of the button to launch the modal must matche the id of the modal dialog.
+The href of the button to launch the modal must match the id of the modal dialog. It also accepts a block for the header, body, and footer. If you are getting a complaint about the modal_helper unable to merge a hash it is due to this.
 
-````
-<%= content_tag :a, "Modal", :href => "#modal", :class => 'btn', :data => {:toggle => 'modal'} %>
+```erb
+<%= content_tag :a, "Modal", href: "#modal", class: 'btn', data: {toggle: 'modal'} %>
 
-<%= modal_dialog :id => "modal",
-         :header => { :show_close => true, :dismiss => 'modal', :title => 'Modal header' },
-                 :body   => 'This is the body',
-                 :footer => content_tag(:button, 'Save', :class => 'btn') %>
-````
+<%= modal_dialog id: "modal",
+         header: { show_close: true, dismiss: 'modal', title: 'Modal header' },
+         body:   { content: 'This is the body' },
+         footer: { content: content_tag(:button, 'Save', class: 'btn') } %>
+
+```
 
 ### Navbar Helper
 It should let you write things like:
 
-````
-<%= nav_bar :fixed => :top, :brand => "Fashionable Clicheizr 2.0", :responsive => true do %>
+```erb
+<%= nav_bar fixed: :top, brand: "Fashionable Clicheizr 2.0", responsive: true do %>
     <%= menu_group do %>
         <%= menu_item "Home", root_path %>
         <%= menu_divider %>
@@ -300,11 +295,11 @@ It should let you write things like:
         <%= menu_item "About Us", about_us_path %>
         <%= menu_item "Contact", contact_path %>
     <% end %>
-    <%= menu_group :pull => :right do %>
+    <%= menu_group pull: :right do %>
         <% if current_user %>
             <%= menu_item "Log Out", log_out_path %>
         <% else %>
-            <%= form_for @user, :url => session_path(:user), html => {:class=> "navbar-form pull-right"} do |f| -%>
+            <%= form_for @user, url: session_path(:user), html => {class: "navbar-form pull-right"} do |f| -%>
               <p><%= f.text_field :email %></p>
               <p><%= f.password_field :password %></p>
               <p><%= f.submit "Sign in" %></p>
@@ -312,109 +307,105 @@ It should let you write things like:
         <% end %>
     <% end %>
 <% end %>
-````
+```
 
 ### Navbar scaffolding
 
 In your view file (most likely application.html.erb) to get a basic navbar set up you need to do this:
 
-````
-<%= nav_bar  %>
-````
+```erb
+<%= nav_bar %>
+```
 
 Which will render:
 
-    <div class="navbar">
-      <div class="navbar-inner">
-        <div class="container">
-        </div>
-      </div>
-    </div>
-
+```html
+<div class="navbar">
+  <div class="container">
+  </div>
+</div>
+```
 
 ### Fixed navbar
 
 If you want the navbar to stick to the top of the screen, pass in the option like this:
 
-````
-<%= nav_bar :fixed => :top  %>
-````
+```erb
+<%= nav_bar fixed: :top  %>
+```
 
 To render:
 
-    <div class="navbar navbar-fixed-top">
-      <div class="navbar-inner">
-        <div class="container">
-        </div>
-      </div>
-    </div>
+```html
+<div class="navbar navbar-fixed-top">
+  <div class="container">
+  </div>
+</div>
+```
 
 ### Static navbar
 
 If you want a full-width navbar that scrolls away with the page, pass in the option like this:
 
-````
-<%= nav_bar :static => :top  %>
-````
+```erb
+<%= nav_bar static: :top  %>
+```
 
 To render:
 
-    <div class="navbar navbar-static-top">
-      <div class="navbar-inner">
-        <div class="container">
-        </div>
-      </div>
-    </div>
-
+```html
+<div class="navbar navbar-static-top">
+  <div class="container">
+  </div>
+</div>
+```
 
 ### Brand name
 
 Add the name of your site on the left hand edge of the navbar. By default, it will link to root_url. Passing a brand_link option will set the url to whatever you want.
 
-````
-<%= nav_bar :brand => "We're sooo web 2.0alizr", :brand_link => account_dashboard_path  %>
-````
+```erb
+<%= nav_bar brand: "We're sooo web 2.0alizr", brand_link: account_dashboard_path  %>
+```
 
 Which will render:
 
-    <div class="navbar">
-      <div class="navbar-inner">
-        <div class="container">
-            <a class="brand" href="/accounts/dashboard">
-              We're sooo web 2.0alizr
-            </a>
-        </div>
-      </div>
-    </div>
-
+```html
+<div class="navbar">
+  <div class="container">
+      <a class="navbar-brand" href="/accounts/dashboard">
+        We're sooo web 2.0alizr
+      </a>
+  </div>
+</div>
+```
 
 ### Optional responsive variation
 
 If you want the responsive version of the navbar to work (One that shrinks down on mobile devices etc.), you need to pass this option:
 
-````
-<%= nav_bar :responsive => true %>
-````
-Which renders the html quite differently:
+```erb
+<%= nav_bar responsive: true %>
+```
 
+Which renders the html quite differently:
 
-    <div class="navbar">
-      <div class="navbar-inner">
-        <div class="container">
-          <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
-          <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
-            <span class="icon-bar"></span>
-            <span class="icon-bar"></span>
-            <span class="icon-bar"></span>
-          </a>
-          <!-- Everything in here gets hidden at 940px or less -->
-          <div class="nav-collapse">
-            <!-- menu items gets rendered here instead -->
-          </div>
-        </div>
-      </div>
+```html
+<div class="navbar">
+  <div class="container">
+    <!-- .navbar-toggle is used as the toggle for collapsed navbar content -->
+    <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+      <span class="icon-bar"></span>
+      <span class="icon-bar"></span>
+      <span class="icon-bar"></span>
+    </button>
+    <!-- Everything in here gets hidden at 940px or less -->
+    <div class="navbar-collapse collapse">
+      <!-- menu items gets rendered here instead -->
     </div>
-
+  </div>
+</div>
+```
 
 ### Nav links
 
@@ -430,9 +421,9 @@ menu_group only takes one argument - :pull - this moves the group left or right
 
 menu_item generates a link wrapped in an li tag. It takes two arguments and an options hash. The first argument is the name (the text that will appear in the menu), and the path (which defaults to "#" if left blank). The rest of the options are passed straight through to the link_to helper, so that you can add classes, ids, methods or data tags etc.
 
-````
-<%= nav_bar :fixed => :top, :brand => "Ninety Ten" do %>
-    <% menu_group do %>
+```erb
+<%= nav_bar fixed: :top, brand: "Ninety Ten" do %>
+    <%= menu_group do %>
         <%= menu_item "Home", root_path %>
         <%= menu_item "About Us", about_us_path %>
         <%= menu_item "Contact", contact_path %>
@@ -440,9 +431,9 @@ menu_item generates a link wrapped in an li tag. It takes two arguments and an o
     <% if current_user %>
         <%= menu_item "Log Out", log_out_path %>
     <% else %>
-        <% menu_group :pull => :right do %>
+        <%= menu_group pull: :right do %>
             <%= menu_item "Sign Up", registration_path %>
-            <% form_for @user, :url => session_path(:user) do |f| -%>
+            <%= form_for @user, url: session_path(:user) do |f| -%>
               <p><%= f.text_field :email %></p>
               <p><%= f.password_field :password %></p>
               <p><%= f.submit "Sign in" %></p>
@@ -450,13 +441,13 @@ menu_item generates a link wrapped in an li tag. It takes two arguments and an o
         <% end %>
     <% end %>
 <% end %>
-````
+```
 
 ### Dropdown menus
 
 For multi-level list options, where it makes logical sense to group menu items, or simply to save space if you have a lot of pages, you can group menu items into drop down lists like this:
 
-````
+```erb
 <%= nav_bar do %>
     <%= menu_item "Home", root_path %>
 
@@ -470,14 +461,14 @@ For multi-level list options, where it makes logical sense to group menu items,
     <%= menu_item "About Us", about_us_path %>
     <%= menu_item "Contact", contact_path %>
 <% end %>
-````
+```
 
 ### Dividers
 
 Dividers are just vertical bars that visually separate logically disparate groups of menu items
 
-````
-<%= nav_bar :fixed => :bottom do %>
+```erb
+<%= nav_bar fixed: :bottom do %>
     <%= menu_item "Home", root_path %>
     <%= menu_item "About Us", about_us_path %>
     <%= menu_item "Contact", contact_path %>
@@ -488,7 +479,7 @@ Dividers are just vertical bars that visually separate logically disparate group
     <%= menu_item "Account Settings", edit_user_account_path(current_user, @account) %>
     <%= menu_item "Log Out", log_out_path %>
 <% end %>
-````
+```
 
 ### Forms in navbar
 
@@ -496,23 +487,23 @@ At the moment - this is just a how to...
 
 You need to add this class to the form itself (Different form builders do this in different ways - please check out the relevant docs)
 
-````css
+```css
 .navbar-form
-````
+```
 To pull the form left or right, add either of these classes:
-````css
+```css
 .pull-left
 .pull-right
-````
+```
 
 If you want the Bootstrap search box (I think it just rounds the corners), use:
-````css
+```css
 .navbar-search
-````
+```
 Instead of:
-````css
+```css
 .navbar-form
-````
+```
 
 To change the size of the form fields, use .span2 (or however many span widths you want) to the input itself.
 
@@ -520,49 +511,63 @@ To change the size of the form fields, use .span2 (or however many span widths y
 
 You can shift things to the left or the right across the nav bar. It's easiest to do this on grouped menu items:
 
-````
-<%= nav_bar :fixed => :bottom do %>
+```erb
+<%= nav_bar fixed: :bottom do %>
     <% menu_group do %>
         <%= menu_item "Home", root_path %>
         <%= menu_item "About Us", about_us_path %>
         <%= menu_item "Contact", contact_path %>
     <% end %>
-    <% menu_group :pull => :right do %>
+    <% menu_group pull: :right do %>
         <%= menu_item "Edit Profile", edit_user_path(current_user) %>
         <%= menu_item "Account Settings", edit_user_account_path(current_user, @account) %>
         <%= menu_item "Log Out", log_out_path %>
     <% end %>
 <% end %>
-````
+```
 
 ### Text in the navbar
 
 If you want to put regular plain text in the navbar anywhere, you do it like this:
 
-````
-<%= nav_bar :brand => "Apple" do %>
+```erb
+<%= nav_bar brand: "Apple" do %>
     <%= menu_text "We make shiny things" %>
     <%= menu_item "Home", root_path %>
     <%= menu_item "About Us", about_us_path %>
 <% end %>
-````
-It also takes the :pull option to drag it to the left or right.
+```
 
+It also takes the :pull option to drag it to the left or right.
 
 ### Flash helper
 
-Add flash helper `<%= bootstrap_flash %>` to your layout (built-in with layout generator)
+Add flash helper `<%= bootstrap_flash %>` to your layout (built-in with layout generator).
+You can pass the attributes you want to add to the main div returned: `<%= bootstrap_flash(class: "extra-class", id: "your-id") %>`
+
 
 ### Breadcrumbs Helpers
 
-*Notice* If your application is using [breadcrumbs-on-rails](https://github.com/weppos/breadcrumbs_on_rails) you will have a namespace collision with the add_breadcrumb method.
-You do not need to use these breadcrumb gems since this gem provides the same functionality out of the box without the additional dependency.
+*Notice* If your application is using [breadcrumbs-on-rails](https://github.com/weppos/breadcrumbs_on_rails) you will have a namespace collision with the add_breadcrumb method. For this reason if breadcrumbs-on-rails is detected in `Gemfile` gem methods will be accessible using `boostrap` prefix, i.e. `render_bootstrap_breadcrumbs` and `add_bootstrap_breadcrumb`
+
+Usually you do not need to use these breadcrumb gems since this gem provides the same functionality out of the box without the additional dependency.
+
+However if there are some `breadcrumbs-on-rails` features you need to keep you can still use them and use this gem with the prefixes explained above.
 
 Add breadcrumbs helper `<%= render_breadcrumbs %>` to your layout.
+You can also specify a divider for it like this: `<%= render_breadcrumbs('>') %>` (default divider is `/`).
+If you do not need dividers at all you can use `nil`: `<%= render_breadcrumbs(nil) %>`.
+
+Full example:
+```ruby
+
+render_breadcrumbs(" / ", { class: '', item_class: '', divider_class: '', active_class: 'active' })
+
+```
 
 ```ruby
 class ApplicationController
-  add_breadcrumb :index, :root_path
+  add_breadcrumb :root # 'root_path' will be used as url
 end
 ```
 
@@ -570,16 +575,15 @@ end
 class ExamplesController < ApplicationController
   add_breadcrumb :index, :examples_path
 
-  def index
-  end
-
-  def show
+  def edit
     @example = Example.find params[:id]
-    add_breadcrumb @example.name, example_path(@example)
-    # add_breadcrumb :show, example_path(@example)
+    add_breadcrumb @example # @example.to_s as name, example_path(@example) as url
+    add_breadcrumb :edit, edit_example_path(@example)
   end
 end
 ```
+All symbolic names translated with I18n. See [I18n Internationalization Support](#i18n-internationalization-support)
+section.
 
 ### Element utility helpers
 
@@ -590,141 +594,44 @@ Badge:
 
 Label:
 ```erb
-<%= label('Gut!', :success) %> <span class="badge badge-success">Gut!</span>
+<%= tag_label('Gut!', :success) %> <span class="label label-success">Gut!</span>
 ```
 
 Glyph:
 ```erb
 <%= glyph(:pencil) %> <i class="icon-pencil"></i>
+
+<%= glyph(:pencil, {tag: :span}) %> <span class="icon-pencil"></span>
+
+<%= glyph(:pencil, {class: 'foo'}) %> <i class="icon-pencil foo"></i>
 ```
 
-###i18n Internationalization Support
-The installer creates an english translation file for you and copies it to config/locales/en.bootstrap.yml
+### I18n Internationalization Support
+The installer creates an English translation file for you and copies it to config/locales/en.bootstrap.yml
 
 
 NOTE: If you are using Devise in your project, you must have a devise locale file
 for handling flash messages, even if those messages are blank. See https://github.com/plataformatec/devise/wiki/I18n
 
 ## Changelog
-<ul>
-  <li>Version 0.0.5 deprecated</li>
-  <li>Asset files updated to latest and removed version numbers</li>
-  <li>Implemented Less::Rails Railtie to use with LESS</li>
-  <li>Fixed railtie to only initialize Less when installed</li>
-  <li>New branch for the static version of Bootstrap (w/o Less) - check static branch</li>
-  <li>Added path to support heroku deploy</li>
-  <li>Rake precompile issue fixed</li>
-  <li>Updated asset files to 1.4.0</li>
-  <li>Updated dependency less-rails (now requires 2.1.0)</li>
-  <li>Added generators</li>
-  <li>Fixed generators</li>
-  <li>Fixed class name conflicts from (bootstrap.js.coffee)</li>
-  <li>Fixed jquery-rails gem version dependency</li>
-  <li>Updated asset files</li>
-  <li>Added new generators (install, layout and themed)</li>
-  <li>Compability to Rails 3.2</li>
-  <li>Transitioning to 2.0</li>
-  <li>Released gem v.2.0rc0</li>
-  <li>Added Haml and Slim support</li>
-  <li>Added Responsive layout support</li>
-  <li>Fixes and release 2.0.0</li>
-  <li>Updated to v2.0.1, versioned v2.0.1.0</li>
-  <li>Released gem v.2.0.3</li>
-  <li>Released gem v.2.0.4</li>
-  <li>Released gem v.2.0.5</li>
-  <li>Added SimpleForm support</li>
-  <li>Added FontAwesome support</li>
-  <li>Released gem v.2.0.6</li>
-  <li>Released gem v.2.0.7</li>
-  <li>Released gem v.2.0.8</li>
-  <li>Released gem v.2.0.9 (Bootstrap 2.0.4 and FontAwesome 2.0 support)</li>
-  <li>Released gem v.2.1.0 (JRuby support)</li>
-  <li>Released gem v.2.1.1 (minor fixes)</li>
-  <li>Flash block message helper added</li>
-  <li>Released gem v.2.1.2 (minor fixes and updated to Twitter Bootstrap 2.1.0)</li>
-  <li>Released gem v.2.1.3 (minor fixes and updated to Twitter Bootstrap 2.1.1)</li>
-  <li>Released gem v.2.1.4 (minor fixes)</li>
-  <li>Released gem v.2.1.5 (minor fixes, install generator detects javascript template engine, updated to Twitter Bootstrap 2.2.1)</li>
-  <li>Released gem v.2.1.6 (minor fixes)</li>
-  <li>Added static stylesheets support</li>
-  <li>Released gem v.2.1.8 and updated to Twitter Bootstrap 2.2.2</li>
-  <li>Released gem v.2.1.9</li>
-  <li>Released gem v.2.2.0 (Font Awesome 3)</li>
-  <li>Released gem v.2.2.1 (minor fixes and updates)</li>
-  <li>Released gem v.2.2.2 (Bootstrap 2.3.0)</li>
-  <li>Released gem v.2.2.3 (Minor fixes)</li>
-  <li>Released gem v.2.2.4 (Minor fixes)</li>
-  <li>Released gem v.2.2.5 (Bootstrap 2.3.1)</li>
-  <li>Released gem v.2.2.6</li>
-  <li>Released gem v.2.2.7 (Fixes)</li>
-  <li>Releases gem v.2.2.8</li>
-</ul>
-
+Please see CHANGELOG.md for more details
 
 ## Contributors & Patches & Forks
-<ul>
-  <li>Ben Lovell</li>
-  <li>Daniel Morris</li>
-  <li>Bradly Feeley</li>
-  <li>Guilherme Moreira</li>
-  <li>Alex Behar</li>
-  <li>Brandon Keene</li>
-  <li>Anthony Corcutt</li>
-  <li>Colin Warren</li>
-  <li>Giovanni Cappellotto</li>
-  <li>Masakuni Kato</li>
-  <li>Gudleik Rasch</li>
-  <li>Thomas Volkmar Worm</li>
-  <li>Thiago Almeida</li>
-  <li>Sébastien Grosjean</li>
-  <li>Nick DeSteffen</li>
-  <li>Christian Joudrey</li>
-  <li>Todd Baur</li>
-  <li>Leonid Shevtsov</li>
-</ul>
+Please see CONTRIBUTERS.md for contributors list
 
 ## About Me
-Lead/ Senior Developer - Programmer @useful (Usefulideas) Istanbul / Turkey
+Senior Software Developer
+Istanbul / Turkey
 
 ### Contact me
 Seyhun Akyürek - seyhunak [at] gmail com
 
-### Follow me
-<a href="http://zerply.com/seyhunak">
-<img width="110" height="40" src="http://zerply.com/img/welcomesteps/zerply_logo.png" />
-</a>
-
-(Twitter, Facebook, Linkedin, Google+, Github)
-
-http://zerply.com/seyhunak
-
-### Endorse me
-<a href="http://coderwall.com/seyhunak">
-<img src="http://api.coderwall.com/seyhunak/endorsecount.png" />
-</a>
-
-### Klout me
-<img src="https://addons.opera.com/media/extensions/55/14355/1.0.1-rev1/icons/icon_64x64.png"></img>
-
-Please +K my influence in Ruby on Rails on @klout
-
-http://klout.com/#/seyhunak
-
-
-### Want to donate?
-<img src="https://www.paypalobjects.com/en_US/i/logo/PayPal_mark_50x34.gif"></img>
-
-[Want to donate for my efforts? Show your love](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=W8ZLWQBREFP4U
- "Donate")
-
-
 ## Thanks
-Twitter Bootstrap and all twitter-bootstrap-rails contributors
-http://twitter.github.com/bootstrap
-
+Bootstrap and all twitter-bootstrap-rails contributors
+http://twbs.github.io/bootstrap
 
 ## License
-Copyright (c) 2012 Seyhun Akyürek
+Copyright (c) 2017 (since 2012) by Seyhun Akyürek
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.