Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Update readme since compass-recipes is available as a gem

  • Loading branch information...
commit 48238c541f87f0d8935654b5ce315076fad453db 1 parent 450a010
Maxime Thirouin MoOx authored
Showing with 39 additions and 3 deletions.
  1. +39 −3 README.md
42 README.md
View
@@ -1,10 +1,44 @@
-# Compass Recipes ![project status](http://stillmaintained.com/MoOx/Compass-Recipes.png) #
+# Compass Recipes ![project status](http://stillmaintained.com/MoOx/compass-recipes.png) #
This project is a collection of Sass mixins using Compass that you can use or learn from.
+## Installation
+
+[Compass-Recipes is now available as a gem on RubyGems.org](https://rubygems.org/gems/compass-recipes). So installation is quite easy.
+
+ gem install compass-recipes
+
+# Usage
+
+When compass-recipes installed, you just need to require the compass plugin in your project
+
+ require 'compass-recipes'
+
+Then you can include some recipes like this
+
+ @import "recipes/shape/triangle";
+ .my-triangle
+ {
+ @include triangle;
+ }
+
+Like Compass does, you can include all recipes in a folder like this
+
+ @import "recipes/shape";
+
+ .my-triangle
+ {
+ @include triangle;
+ }
+
+ .my-square
+ {
+ @include square;
+ }
+
## Demos
-http://moox.github.com/Compass-Recipes/
+http://moox.github.com/compass-recipes/
## TODO
* Create tests for all existing mixins
@@ -18,4 +52,6 @@ http://moox.github.com/Compass-Recipes/
Compass-Recipes is maintained by Maxime Thirouin, a front-end web developer working for Shopbot-inc.com
## Open to All
-Anyone who forks this project and submits a patch and pull request will be given commit access after the first patch is accepted.
+Fork, modify, push, submit pull request ! That's easy !
+
+*I'm not a Ruby coder, so anyone which want to help me for anything will be appreciated !*
Please sign in to comment.
Something went wrong with that request. Please try again.