Permalink
Browse files

Add eyeglass support

  • Loading branch information...
1 parent 824e86b commit 2089166472aae63fe7d3bfe3357bafccb3c97bc4 @chriseppstein chriseppstein committed with tysongach Sep 11, 2015
Showing with 33 additions and 3 deletions.
  1. +17 −0 README.md
  2. +7 −0 eyeglass-exports.js
  3. +2 −2 index.js
  4. +7 −1 package.json
View
@@ -90,6 +90,23 @@ For command line help, visit our wiki page on Neat’s [command line interface](
It should be noted that `@import` rules are not compatible with Sprockets directives. You need to use one or the other.
+## Installing with npm and using a Node-based asset pipeline
+
+1. Add Neat as a dependency:
+
+ ```bash
+ npm install --save bourbon-neat
+ ```
+
+1. If you’re using [Eyeglass](http://eyeglass.rocks), skip to Step 3. Otherwise, you’ll need to add Bourbon and Neat to your node-sass `includePaths` option. `require("bourbon-neat").includePaths` is an array of directories that you should pass to node-sass. How you do this depends on how node-sass is integrated into your project. You will also need to ensure that Bourbon is in the `includePaths` passed to node-sass.
+
+1. Import Neat into your Sass files, after Bourbon:
+
+ ```scss
+ @import "bourbon";
+ @import "neat";
+ ```
+
## Installing older versions of Neat
1. Uninstall any Neat gem versions you already have:
View
@@ -0,0 +1,7 @@
+var neat = require("./index");
+
+module.exports = function(eyeglass, sass) {
+ return {
+ sassDir: neat.includePaths[0]
+ };
+};
View
@@ -1,7 +1,7 @@
-var path = require('path');
+var path = require("path");
module.exports = {
includePaths: [
- path.join(__dirname, 'app/assets/stylesheets'),
+ path.join(__dirname, "app/assets/stylesheets"),
]
};
View
@@ -13,7 +13,8 @@
"queries",
"sass",
"scss",
- "semantic"
+ "semantic",
+ "eyeglass-module"
],
"homepage": "http://neat.bourbon.io",
"bugs": {
@@ -38,5 +39,10 @@
"gulp-connect": "^2.2.0",
"gulp-sass": "^2.0.2",
"node-bourbon": "^4.2.3"
+ },
+ "eyeglass": {
+ "name": "neat",
+ "needs": "*",
+ "exports": "eyeglass-exports.js"
}
}

0 comments on commit 2089166

Please sign in to comment.