# Breezeblocks

[![Gem Version](https://badge.fury.io/rb/breezeblocks.svg)](http://badge.fury.io/rb/breezeblocks)

## Prepackaged patterns and components built with Bourbon and Neat, based on Refills

Demo here: [http://gazaston.github.io/breezeblocks](http://gazaston.github.io/breezeblocks)

## Requirements

- [Sass](https://github.com/sass/sass) 3.3+
- [Bourbon](https://github.com/thoughtbot/bourbon) 4.0+
- [Neat](https://github.com/thoughtbot/neat) 1.6+

## Installation for Ruby on Rails

1. Add Breezeblocks to your Gemfile:

  ```ruby
  gem 'breezeblocks'
  ```

2. Then run:

  ```bash
  bundle install
  ```

3. Use the following Rails generators:

  List all available snippets:

  ```bash
  rails generate breezeblocks:list
  ```

  Add a snippet:

  ```bash
  rails generate breezeblocks:import SNIPPET
  ```

  If you want to generate coffeescript instead of javascript, simply add `--coffee`

  ```bash
  rails generate breezeblocks:import SNIPPET --coffee
  ```

  This copies the snippet’s partial to `app/views/breezeblocks`, the stylesheet to `app/assets/stylesheets/breezeblocks` and the JavaScript to `app/assets/javascripts/breezeblocks`

## Contributing

If you want to improve or add a snippet, please do so via pull request. If you rename/remove/add any files to the repository, please make sure that the build reflects that change. Add your changed file to the `SNIPPETS` constant in the [test][spec_file] to have it tested. And make sure you add it to source/index so it can be previewed!

[spec_file]: https://github.com/thoughtbot/breezeblocks/blob/master/spec/breezeblocks/import_generator_spec.rb

Run `rake` to start the spec tests. 

## GH Pages

Uses middleman with [middleman-gh-pages](https://github.com/neo/middleman-gh-pages) for GitHub Pages generation. Run `rake publish` to build and deploy changes.

## Credits

Breezeblocks owes everything to Refills, which is maintained and funded by [thoughtbot, inc](http://thoughtbot.com).