Commit d78f7bad authored by Björn Bartels's avatar Björn Bartels

update readme

parent 9641e3a7
......@@ -6,15 +6,16 @@ Panini isn't a full-fledged static site generator—rather, it solves the ve
## Installation
For now, just add
```bash
"patternlibrary": "file:../../js/patternlibrary"
"patternlibrary": "file:path/to/patternlibrary"
```
to your **package.json** file.
to your `package.json` file.
Once this might be ready, install via npm
```bash
......@@ -23,6 +24,7 @@ npm install patternlibrary --save-dev
## Usage
Feed the pattern-library a stream of HTML files, and get the compiled patterns and a frontend out the other end.
......@@ -62,6 +64,7 @@ gulp.watch(['./src/{layouts,partials,helpers,data}/**/*'], [patternlibrary.refre
## Options
### `dest`
......@@ -110,12 +113,13 @@ Set panini options. **mandatory**
## CLI
You can (currently not yet) use the pattern-library via the CLI.
```
THIS IS SUBJECT TO CHANGE! D O N O T U S E ! ! !
Usage: patternlibrary --layouts=[layoutdir] --root=[rootdir] --dest=[destdir] [other options]
Options:
......@@ -125,8 +129,9 @@ Options:
--partials path to root folder for partials
--helpers path to folder for additional helpers
--data path to folder for additional data
...
Example: patternlibrary --root=src/pages --layouts=src/layouts --partials=src/partials --data=src/data --output=dist 'src/pages/**/*.html'
Example: patternlibrary --root=src/pages --layouts=src/layouts --partials=src/partials --data=src/data --output=dist ...
```
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment