Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dariusrosendahl authored Nov 23, 2016
1 parent ee43eea commit b43fdd3
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
## CastleCSS Framework
The core files are part of the [CastleCSS Package](https://github.com/CastleCSS/castlecss)


## How to install
- Install via [npm](https://www.npmjs.com/): ```npm install castlecss-core```
- Require it in your own npm package
Expand All @@ -19,6 +18,13 @@ CastleCSS is built so it's easy to update, you can just download make it your ow
You can find the documentation and examples at http://www.castlecss.com and [castlecss-docs](https://github.com/CastleCSS/castlecss-docs)


## Adjusting the variables
Because of the unique update-able setup of CastleCSS you need a seperate variable file to overwrite the default CastleCSS variables. There are a few ways to do this:

- Use the [boilerplate](https://github.com/CastleCSS/castlecss-boilerplate/) which provides a variables.scss file
- Copy variables.scss from /node_modules/castlecss-core/sass/variables.scss into your own scss folder and include it into your main.scss
- Copy the example from the [documentation](http://castlecss.com/variables.html) into your own variables.scss and include it into your main.scss

## Basic structure
The basis structure for your website should look similar like this:

Expand Down

0 comments on commit b43fdd3

Please sign in to comment.