From d93e690a47b62fbb7a1d1dc85e98cdff67e8cdc5 Mon Sep 17 00:00:00 2001 From: Benjamin Quorning Date: Apr 18 2016 11:02:10 +0000 Subject: Add more details on installation and usage --- diff --git a/README.md b/README.md index 4e7e1ee..afd1e89 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,34 @@ This gem combines the speed of `libsass`, the [Sass C implementation](https://gi [3.3.4](https://github.com/sass/libsass/releases/tag/3.3.4) +## Installation + +Add this line to your application's Gemfile: + +```ruby +gem 'sassc' +``` + +And then execute: + +```bash +bundle +``` + +Or install it yourself as: + +```bash +gem install sassc +``` + ## Usage This library utilizes `libsass` to allow you to compile SCSS or SASS syntax -to CSS. To compile, use a `SassC::Engine`. +to CSS. To compile, use a `SassC::Engine`, e.g.: + +```ruby +SassC::Engine.new(sass, style: :compressed).render +``` **Note**: If you want to use this library with Rails/Sprockets, check out [sassc-rails](https://github.com/bolandrm/sassc-rails).