Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rikki-iki committed Mar 3, 2016
1 parent 446c116 commit dd69250
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
# kss-node-offscreen-template
A kss-node template with offscreen menu
# Template for kss-node with offscreen menu

This is a **template** for [kss-node](https://github.com/kss-node/kss-node) living styleguide. It feature a toggle-able sidebar menu so you can choose to see the styleguide at full browser width.

## How to apply this template

1. Install kss-node. Type `npm install kss` or `npm install -g kss` for global CLI.
2. Download [kss-node-offscreen-template](https://github.com/previousnext/kss-node-offscreen-template/archive/master.zip) and copy the "template" folder into your working directory.
3. Run `kss-node` command with `--template` option, like below.

```
kss-node <sourcedir> --template path/to/template
```

0 comments on commit dd69250

Please sign in to comment.