From 481f60bc9cc26ba8ef8c77bc8089a2dd7b62f7a4 Mon Sep 17 00:00:00 2001 From: samthurman Date: Wed, 29 Jul 2015 16:07:34 -0400 Subject: [PATCH] Update README.md for accuracy Pulling a node module using a github URL will not honor .npmignore, it pulls in everything. Updated docs to reflect that. --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 50e3efd2..69ab16c4 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,14 @@ Append the repository to your project's package.json's dependency list: ``` "solid": "git+ssh://git@github.com:buzzfeed/solid.git#" ``` -This will give you `solid.scss` and all of its scss files inside `node_modules`. This package only includes the static, uncompiled SCSS files. Whether you want to build them into your project with Grunt, Gulp, etc. is up to you. +This will give you `solid.scss` and all of its scss files inside `node_modules/solid/lib`. This package includes the static, uncompiled SCSS files. Whether you want to build them into your project with Grunt, Gulp, etc. is up to you. + +Including the package using a github URL will also include all of the styleguide's template `.ejs` files. Please disregard. ## Building the Solid Styleguide The solid styleguide lets you view Solid along with all of its documentation. -## Set Up +## Set Up the Styleguide Locally (optional) ### Dependencies