bootstrap-rails-helpers 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 438c8eec6771a0da7e08b149e5737ed3e8c82db4
-  data.tar.gz: 1cc566e67e20d73cc4fbc972f42f8750c1a18a43
+  metadata.gz: a6528628e83f9892fa12123b61de30f0bc1041f5
+  data.tar.gz: 6e5d09c127e3cc6ea865a1880d270f1c751ca5f1
 SHA512:
-  metadata.gz: 9bd981e37a42a523a65efda03c2f47349d6dee01846f67b32b8fe57984af2552edd67fe1e70f7ccbe44d93fbc01d23454f03d03e471da56a70d9b7aace1a6357
-  data.tar.gz: c0bd39366e52064ec3efa07844267ae7a7a7fa7c7e13cdc6f479847ed393a6bd11322dc64fd264bf5463834789675d7498d2e9b3b3261f85999f01de13bc450f
+  metadata.gz: af61ee98a3b9fb5b14c5499436dc68a4f4c44375388506182852f1017915732609c88233a78769e43054c48544c0e9c97f7ed850dd2c6fb52aaf935090746656
+  data.tar.gz: e4ed941b4772a7b45187d646263f327261a6ae7f8bc5511cedbb4a7d7ec9bf5b4bdf77053c3abeb210d4846e12192ceb0a5ca20ece59437ba27e5d0756074917

data/README.md

@@ -0,0 +1,116 @@
+bootstrap-rails-helpers
+=======================
+
+[Bootstrap](http://twitter.github.com/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.
+
+bootstrap-rails-helpers is a lightweight gem that includes many helper methods used in many Rails applications.
+
+Installation
+------------
+
+As most of the heleprs are based off it, if you are already using twitter-bootstrap-rails (https://github.com/seyhunak/twitter-bootstrap-rails), then you already have most of these helpers in place.
+
+If you haven't already installed Twitter Bootstrap, you will need to add it to your project.
+
+You can install Bootstrap using one of the following gems:
+
+- bootstrap-sass (https://github.com/thomas-mcdonald/bootstrap-sass)
+- sass-twitter-bootstrap (https://github.com/jlong/sass-twitter-bootstrap)
+- less-rails-bootstrap (https://github.com/metaskills/less-rails-bootstrap)
+
+Or you could add it directly to your assets pipeline by downloading [Twitter Bootstrap](http://twitter.github.com/bootstrap/) directly.
+
+Once you have Twitter Bootstrap available you just need to add the following to your Gemfile.
+
+```ruby
+gem 'bootstrap-rails-helpers'
+```
+
+Once that's in place, run `bundle install` and you're ready.
+
+Helpers
+-------
+
+### Flash Messages
+
+Rails provides a standard convention called flash to display alerts (including error messages) and other notices.
+
+Add the following tag to `<%= bootstrap_flash %>` to your layout in order for each message to be displayed as an [Alerts](http://twitter.github.com/bootstrap/components.html#alerts).
+
+Rails uses :notice and :alert as its defailt flash message keys. The `bootstrap_flash` tag converts these statuses to `.alert-success` and `.alert-error`.
+
+You can add individual alert boxes using the following tag:
+
+```ruby
+<%= alert_message "Hello Bootstrap", :alert_type => :success %>
+```
+
+### Breadcrumbs
+
+Add the breadcrumbs tag `<%= render_breadcrumbs %>` to your layout to add a series of breadcrumbs to your views.
+
+From within your views, use the `add_breadcrumb` tag to populate the breadcrumb list.
+
+```ruby
+# examples/index.html.erb
+<%- add_breadcrumb :index, examples_url -%>
+```
+
+```ruby
+# examples/show.html.erb
+<%- add_breadcrumb :index, examples_url -%>
+<%- add_breadcrumb @example.title, example_url(@example) -%>
+```
+
+```ruby
+# examples/new.html.erb
+<%- add_breadcrumb :index, examples_url -%>
+<%- add_breadcrumb :new, new_example_url -%>
+```
+
+```ruby
+# examples/edit.html.erb
+<%- add_breadcrumb :index, examples_url -%>
+<%- add_breadcrumb @example.title, example_url(@example) -%>
+<%- add_breadcrumb :edit, edit_example_url(@example) -%>
+```
+
+Ruby symbols used for labes fall back to I18n translations based off the current controller, Translations fall back to the defaults namespace if the exact translation path is not found.
+
+```yml
+en:
+  breadcrumbs:
+    defaults:
+      home: 'Home'
+      index: 'Index'
+      edit: 'Edit'
+      show: 'Show'
+      new: 'New'
+      
+    examples:
+      index: 'Examples'
+      new: 'New Example'
+      edit: 'Edit Example'
+```
+
+### Glyphs
+
+You can easily use [Icons](http://twitter.github.com/bootstrap/base-css.html#icons) by [Glyphicons](http://glyphicons.com/) in your views by using the `glyph` tag.
+
+```ruby
+<%= glyph(:share_alt) %>
+# => <i class="icon-share-alt"></i>
+```
+You can also use the white icon variation:
+
+```ruby
+glyph(:lock, :white)
+# => <i class="icon-lock icon-white"></i>
+```
+
+License
+-------
+
+Copyright (c) 2013 Ben Morrall
+
+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. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/bootstrap-rails-helpers.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |s|
   s.version     = BootstrapRailsHelpers::VERSION
   s.authors     = ["bmorrall"]
   s.email       = ["bemo56@hotmail.com"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/bmorrall/bootstrap-rails-helpers"
   s.summary     = %q{Twitter Bootstrap Helpers for Rails}
-  s.description = %q{Adds Helpers for Rails that take advantage of Twitter Boostrap, based off code from https://github.com/seyhunak/twitter-bootstrap-rails}
+  s.description = %q{Adds several ActionView helpers to improve Twitter Bootstrap integration with Rails}
 
   s.rubyforge_project = "bootstrap-rails-helpers"
 

data/lib/bootstrap_rails_helpers/version.rb

@@ -1,3 +1,3 @@
 module BootstrapRailsHelpers
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bootstrap-rails-helpers
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - bmorrall
@@ -66,8 +66,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Adds Helpers for Rails that take advantage of Twitter Boostrap, based
-  off code from https://github.com/seyhunak/twitter-bootstrap-rails
+description: Adds several ActionView helpers to improve Twitter Bootstrap integration
+  with Rails
 email:
 - bemo56@hotmail.com
 executables: []
@@ -76,6 +76,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- README.md
 - Rakefile
 - app/helpers/bootstrap_rails_helpers/breadcrumbs_helper.rb
 - app/helpers/bootstrap_rails_helpers/flash_helper.rb
@@ -96,7 +97,7 @@ files:
 - spec/helpers/bootstrap_rails_helpers/glyph_helper_spec.rb
 - spec/helpers/bootstrap_rails_helpers/modal_helper_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/bmorrall/bootstrap-rails-helpers
 licenses: []
 metadata: {}
 post_install_message: