Skip to content

Commit

Permalink
Update README.md for accuracy
Browse files Browse the repository at this point in the history
Pulling a node module using a github URL will not honor .npmignore, it pulls in everything. Updated docs to reflect that.
  • Loading branch information
samthurman committed Jul 29, 2015
1 parent 27ade1b commit 481f60b
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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#<RELEASE_VERSION>"
```
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

Expand Down

0 comments on commit 481f60b

Please sign in to comment.