Skip to content

Commit 45ddb5c

Browse files
authored
Merge pull request #41 from bquorning/more-detailed-readme
Add more details on installation and usage
2 parents 4e087c6 + d93e690 commit 45ddb5c

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,34 @@ This gem combines the speed of `libsass`, the [Sass C implementation](https://gi
88

99
[3.3.4](https://github.com/sass/libsass/releases/tag/3.3.4)
1010

11+
## Installation
12+
13+
Add this line to your application's Gemfile:
14+
15+
```ruby
16+
gem 'sassc'
17+
```
18+
19+
And then execute:
20+
21+
```bash
22+
bundle
23+
```
24+
25+
Or install it yourself as:
26+
27+
```bash
28+
gem install sassc
29+
```
30+
1131
## Usage
1232

1333
This library utilizes `libsass` to allow you to compile SCSS or SASS syntax
14-
to CSS. To compile, use a `SassC::Engine`.
34+
to CSS. To compile, use a `SassC::Engine`, e.g.:
35+
36+
```ruby
37+
SassC::Engine.new(sass, style: :compressed).render
38+
```
1539

1640
**Note**: If you want to use this library with Rails/Sprockets, check out
1741
[sassc-rails](https://github.com/bolandrm/sassc-rails).

0 commit comments

Comments
 (0)