Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Sugar, tastefully bundled for the Rails 3.0 and up. Sweet!

README.md

sugar-rails

Description

Sugar, tastefully bundled for the Rails 3.0 and up. Sweet!

Requirements

This gem requires Rails 3.0+ and has been tested on the following versions:

  • 4.0
  • 3.0
  • 3.1
  • 3.2

This gem has been tested against the following Ruby versions:

  • MRI 1.8.7
  • REE 1.8.7
  • 1.9.2
  • 1.9.3
  • JRuby
  • Rubinius

Installation

Add this line to your application's Gemfile:

gem "sugar-rails"

And then execute:

$ bundle

Or install it yourself as:

$ gem install sugar-rails

Usage

sugar-rails supports both default and customized builds of Sugar.

Rails 3.1+

For Rails 3.1 and greater, the files will be added to the asset pipeline and available for you to use.

To enable:

  • Add the following line to the file app/assets/javascripts/application.js (or other sprockets manifest):
//= require sugar

The following default builds are available:

  • sugar (default minified package)
  • sugar-full (full minified package)
  • sugar-development (full development package)

Rails 3.0

This gem adds an installation generator to Rails 3, sugar:install. Running the generator will install the JavaScript file (default minified package) necessary to use Sugar.

  • Invoke the generator:
$ rails generate sugar:install
  • Add the following to your layout or view files:
<%= javascript_include_tag "sugar" %>

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a Pull Request

Contributors

Many thanks go to the following who have contributed to making this gem even better:

License

sugar-rails

Sugar

  • Freely distributable and licensed under the MIT-style license.
  • Copyright (c) 2012 Andrew Plummer
  • http://sugarjs.com/

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, sub-license, 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 every other copyright notice found in this software, and all the attributions in every file, 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 NON-INFRINGEMENT. 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.

Something went wrong with that request. Please try again.