Commit adf5d5e5 by Andrew Nesbitt

Merge pull request #265 from andrew/readme-build-update

README tweaks
parents 2dd0c6ff 96a82ebb
......@@ -3,4 +3,10 @@
* Make your feature addition or bug fix.
* Add documentation if necessary.
* Add tests for it. This is important so I don't break it in a future version unintentionally.
* Send a pull request. Bonus points for topic branches.
\ No newline at end of file
* Send a pull request. Bonus points for topic branches.
The [`libsass` C++ library](https://github.com/hcatlin/libsass) that this library binds to is not currently at feature parity with the [Ruby Gem](https://github.com/nex3/sass) that most Sass users will use. While we try our best to maintain feature parity with `libsass`, we can not enable features that have not been implemented in `libsass` yet.
If you'd like to see what features are still upcoming in `libsass`, [Jo Liss](http://twitter.com/jo_liss) has written [a recent blog post on the subject](http://www.solitr.com/blog/2014/01/state-of-libsass/).
Please check the [Issues on the `libsass` repo](https://github.com/hcatlin/libsass/issues) before opening an issue here, as there is a good chance that it may be an issue there for it. If not, then by all means, open an issue here and we'll look into it.
\ No newline at end of file
......@@ -5,6 +5,7 @@
[![Dependency Status](https://david-dm.org/andrew/node-sass.png?theme=shields.io)](https://david-dm.org/andrew/node-sass)
[![devDependency Status](https://david-dm.org/andrew/node-sass/dev-status.png?theme=shields.io)](https://david-dm.org/andrew/node-sass#info=devDependencies)
[![Coverage Status](https://coveralls.io/repos/andrew/node-sass/badge.png)](https://coveralls.io/r/andrew/node-sass)
[![Gitter chat](https://badges.gitter.im/andrew/node-sass.png)](https://gitter.im/andrew/node-sass)
Node-sass is a library that provides binding for Node.js to [libsass](https://github.com/hcatlin/libsass), the C version of the popular stylesheet preprocessor, Sass.
......@@ -12,6 +13,14 @@ It allows you to natively compile .scss files to css at incredible speed and aut
Find it on npm: <https://npmjs.org/package/node-sass>
## Important note on `libsass`
The [`libsass` C++ library](https://github.com/hcatlin/libsass) that this library binds to is not currently at feature parity with the [Ruby Gem](https://github.com/nex3/sass) that most Sass users will use. While we try our best to maintain feature parity with `libsass`, we can not enable features that have not been implemented in `libsass` yet.
If you'd like to see what features are still upcoming in `libsass`, [Jo Liss](http://twitter.com/jo_liss) has written [a recent blog post on the subject](http://www.solitr.com/blog/2014/01/state-of-libsass/).
Please check the [Issues on the `libsass` repo](https://github.com/hcatlin/libsass/issues) before opening an issue here, as there is a good chance that it may be an issue there for it. If not, then by all means, open an issue here and we'll look into it.
## Install
npm install node-sass
......@@ -154,10 +163,6 @@ Check out the project:
npm install -g node-gyp
node-gyp rebuild
Replace the prebuild binary with your newly generated one
cp build/Release/binding.node precompiled/*your-platform*/binding.node
## Command Line Interface
The interface for command-line usage is fairly simplistic at this stage, as seen in the following usage section.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment