seed-color-scheme-helpscout - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

index.js

@@ -5,2 +5,3 @@ var path = require('path');
 var files = pathfinder(
+  require('seed-color-scheme'),
   path.join(__dirname, 'scss')
@@ -7,0 +8,0 @@ );

package.json

 {
   "name": "seed-color-scheme-helpscout",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Help Scout color scheme for Seed",
@@ -50,4 +50,4 @@ "main": "index.js",
   "dependencies": {
-    "seed-color-fn": "0.1.1"
+    "seed-color-scheme": "0.0.1"
   }
 }

README.md

@@ -10,3 +10,6 @@ # seed-color-scheme-helpscout [![Build Status](https://travis-ci.org/helpscout/seed-color-scheme-helpscout.svg?branch=master)](https://travis-ci.org/helpscout/seed-color-scheme-helpscout) [![npm version](https://badge.fury.io/js/seed-color-scheme-helpscout.svg)](https://badge.fury.io/js/seed-color-scheme-helpscout) [![Dependencies](https://david-dm.org/helpscout/seed-color-scheme-helpscout.svg)](https://david-dm.org/helpscout/seed-color-scheme-helpscout)
 
+## Dependencies
+* [Seed Color scheme](https://github.com/helpscout/seed-color-scheme)
 
+
 ## Basic Usage
@@ -32,2 +35,25 @@
 
+**Note:** Because seed-color-scheme-helpscout has dependencies, its includePaths output will be an `array`. If you're including other paths in addition to seed-color-scheme-helpscout, you will need to flatten the array. An easy way to do this is to use [sass-pathfinder](https://github.com/itsjonq/sass-pathfinder).
+
+Example with *sass-pathfinder*:
+
+```javascript
+var gulp = require('gulp');
+var sass = require('gulp-sass');
+
+gulp.task('sass', function () {
+  return gulp.src('./sass/**/*.scss')
+    .pipe(sass({
+      includePaths: pathfinder(
+        './scss/vendor/example',
+        './scss/plugins/super-awesome-plugin',
+        require('seed-color-scheme'),
+        require('seed-color-scheme-helpscout')
+      )
+    }))
+    .pipe(gulp.dest('./css'));
+});
+```
+
+
 Once that is setup, simply `@import` *seed-color-scheme-helpscout* as needed in your `.scss` file:
@@ -34,0 +60,0 @@

scripts/build.js

@@ -11,3 +11,3 @@ 'use strict';
 var includePaths = pathfinder(
-  require('seed-color-fn')
+  require('seed-color-scheme')
 );
@@ -14,0 +14,0 @@

scripts/test.js

@@ -9,3 +9,3 @@ 'use strict';
 var includePaths = pathfinder(
-  require('seed-color-fn')
+  require('seed-color-scheme')
 );
@@ -12,0 +12,0 @@

No alert changes

Improved metrics

Total package byte prevSize

13736

7.09%

Lines of code

133

0.76%

Number of lines in readme file

204

14.61%

Dependency changes

• + Added

  seed-color-scheme@0.0.1

• + Added

  seed-color-scheme@0.0.1
  (transitive)

• - Removed

  seed-color-fn@0.1.1

• - Removed

  seed-color-fn@0.1.1
  (transitive)