Skip to content

Commit 79ef720

Browse files
committed
update readme
1 parent 78f900c commit 79ef720

File tree

1 file changed

+28
-9
lines changed

1 file changed

+28
-9
lines changed

README.md

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,28 @@
11
# SassC::Rails [![Build Status](https://travis-ci.org/bolandrm/sassc-rails.svg)](https://travis-ci.org/bolandrm/sassc-rails) [![Gem Version](https://badge.fury.io/rb/sassc-rails.svg)](http://badge.fury.io/rb/sassc-rails)
22

3-
### WIP.
3+
We all love working with Sass, but compilation can take quite a long time for larger
4+
codebases. This gem integrates the C implementation of Sass,
5+
[libsass](https://github.com/sass/libsass), into the asset pipeline.
6+
7+
In one larger project, this made compilation 4x faster:
8+
9+
```
10+
# Using sassc-rails
11+
12+
[1] pry(main)> Benchmark.bm { |bm| bm.report { Rails.application.assets["application.css"] } }
13+
user system total real
14+
1.720000 0.170000 1.890000 ( 1.936867)
15+
16+
# Using sass-rails
17+
18+
[1] pry(main)> Benchmark.bm { |bm| bm.report { Rails.application.assets["application.css"] } }
19+
user system total real
20+
7.820000 0.250000 8.070000 ( 8.106347)
21+
```
22+
23+
This should essentially be a drop in alternative to [sass-rails](https://github.com/rails/sass-rails).
24+
25+
_Note: This is a new project, please report any issues you come across!_
426

527
## Installation
628

@@ -15,14 +37,11 @@ And then execute:
1537
$ bundle
1638

1739

18-
## Usage
19-
20-
TODO: Write usage instructions here
21-
2240
## Contributing
2341

2442
1. Fork it ( https://github.com/[my-github-username]/sassc-rails/fork )
25-
2. Create your feature branch (`git checkout -b my-new-feature`)
26-
3. Commit your changes (`git commit -am 'Add some feature'`)
27-
4. Push to the branch (`git push origin my-new-feature`)
28-
5. Create a new Pull Request
43+
1. Create your feature branch (`git checkout -b my-new-feature`)
44+
1. Commit your changes (`git commit -am 'Add some feature'`)
45+
1. Add Tests
46+
1. Push to the branch (`git push origin my-new-feature`)
47+
1. Create a new Pull Request

0 commit comments

Comments
 (0)