Skip to content

Commit

Permalink
fix(README): update content for consistency
Browse files Browse the repository at this point in the history
part of #815
  • Loading branch information
bmuenzenmeyer committed Mar 10, 2018
1 parent 9abb8ac commit 4edf0d4
Show file tree
Hide file tree
Showing 10 changed files with 61 additions and 313 deletions.
19 changes: 10 additions & 9 deletions packages/engine-handlebars/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# The Handlebars engine for Pattern Lab / Node
# The Handlebars PatternEngine for Pattern Lab / Node

To install the Handlebars engine in your edition, `npm install patternengine-node-handlebars` should do the trick.
To install the Handlebars PatternEngine in your edition, `npm install @pattern-lab/engine-handlebars` should do the trick.

## Supported features
- [x] [Includes](http://patternlab.io/docs/pattern-including.html)
- [x] Lineage
- [x] [Hidden Patterns](http://patternlab.io/docs/pattern-hiding.html)
- [x] [Pseudo-Patterns](http://patternlab.io/docs/pattern-pseudo-patterns.html)
- [x] [Pattern States](http://patternlab.io/docs/pattern-states.html)
- [ ] [Pattern Parameters](http://patternlab.io/docs/pattern-parameters.html) (Accomplished instead using [native Handlebars partial arguments](http://handlebarsjs.com/partials.html))
- [ ] [Style Modifiers](http://patternlab.io/docs/pattern-stylemodifier.html) (Accomplished instead using [native Handlebars partial arguments](http://handlebarsjs.com/partials.html))

* [x] [Includes](http://patternlab.io/docs/pattern-including.html)
* [x] Lineage
* [x] [Hidden Patterns](http://patternlab.io/docs/pattern-hiding.html)
* [x] [Pseudo-Patterns](http://patternlab.io/docs/pattern-pseudo-patterns.html)
* [x] [Pattern States](http://patternlab.io/docs/pattern-states.html)
* [ ] [Pattern Parameters](http://patternlab.io/docs/pattern-parameters.html) (Accomplished instead using [native Handlebars partial arguments](http://handlebarsjs.com/partials.html))
* [ ] [Style Modifiers](http://patternlab.io/docs/pattern-stylemodifier.html) (Accomplished instead using [native Handlebars partial arguments](http://handlebarsjs.com/partials.html))
19 changes: 9 additions & 10 deletions packages/engine-liquid/README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
# The Liquid engine for Pattern Lab / Node
# The Liquid PatternEngine for Pattern Lab / Node

Based on the the stellar initial work found in https://github.com/cameronroe/patternengine-node-liquid

## Installing

To install the Underscore engine in your edition, `npm install pattern-lab/patternengine-node-underscore` should do the trick.

To install the Liquid PatternEngine in your edition, `npm install @pattern-lab/engine-liquid` should do the trick.

## Supported features

This PatternEngine is in alpha and considered a work in progress.

- [x] [Includes](http://patternlab.io/docs/pattern-including.html)
- [x] Lineage
* [x] [Includes](http://patternlab.io/docs/pattern-including.html)
* [x] Lineage

**TBD**

- [ ] [Hidden Patterns](http://patternlab.io/docs/pattern-hiding.html)
- [ ] [Pseudo-Patterns](http://patternlab.io/docs/pattern-pseudo-patterns.html)
- [ ] [Pattern States](http://patternlab.io/docs/pattern-states.html)
- [ ] [Pattern Parameters](http://patternlab.io/docs/pattern-parameters.html)
- [ ] [Style Modifiers](http://patternlab.io/docs/pattern-stylemodifier.html)
* [ ] [Hidden Patterns](http://patternlab.io/docs/pattern-hiding.html)
* [ ] [Pseudo-Patterns](http://patternlab.io/docs/pattern-pseudo-patterns.html)
* [ ] [Pattern States](http://patternlab.io/docs/pattern-states.html)
* [ ] [Pattern Parameters](http://patternlab.io/docs/pattern-parameters.html)
* [ ] [Style Modifiers](http://patternlab.io/docs/pattern-stylemodifier.html)
6 changes: 3 additions & 3 deletions packages/engine-mustache/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## The Mustache engine for Pattern Lab / Node
## The Mustache PatternEngine for Pattern Lab / Node

This one should be included by default with [Pattern Lab Node Core](https://github.com/pattern-lab/patternlab-node) and consumed by [Node Editions](https://github.com/pattern-lab?utf8=%E2%9C%93&query=edition-node).
This one should be included by default with [Pattern Lab Node Core](https://github.com/pattern-lab/patternlab-node/packages/core) and consumed by [Node Editions](https://github.com/pattern-lab?utf8=%E2%9C%93&query=edition-node).

If it's missing from your project for any reason, `npm install patternengine-node-mustache` should do the trick.
If it's missing from your project for any reason, `npm install @pattern-lab/engine-mustache` should do the trick.
10 changes: 7 additions & 3 deletions packages/engine-react/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
# The React engine for Pattern Lab / Node
# The React PatternEngine for Pattern Lab / Node

This is the **very preliminary** React engine for Patternlab/Node.
This is the **very preliminary** React PatternEngine for Patternlab / Node.

## Status

You can author standalone React components that include only the main React module, which I know isn't much yet. We're working on it.

The current release works with the 2.X series of Patternlab / Node. Support for the 3.X series is underway on the `dev` branch.

## Supported Pattern Lab
## Installing

To install the React PatternEngine in your edition, `npm install @pattern-lab/engine-react` should do the trick.

## Supported features

* [x] [Includes](http://patternlab.io/docs/pattern-including.html)
* [x] Data inheritance: This can be achieved by combining react `props` & `defaultProps`
Expand Down
15 changes: 12 additions & 3 deletions packages/engine-twig/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
## The Twig engine for Pattern Lab / Node
## The Twig PatternEngine for Pattern Lab / Node

To install the Twig engine in your edition, `npm install patternengine-node-twig` should do the trick.
To install the Twig engine in your edition, `npm install @pattern-lab/engine-twig` should do the trick.

Level of Support is more or less full. Partial calls and lineage hunting are supported. Twig does not support the mustache-specific syntax extensions, style modifiers and pattern parameters, because their use cases are addressed by the core Twig feature set.
## Supported features

Level of support is more or less full. Partial calls and lineage hunting are supported. Twig does not support the mustache-specific syntax extensions, style modifiers and pattern parameters, because their use cases are addressed by the core Twig feature set.

We are looking for help with the following issues:

* [Pattern Lab does not support twig extends](https://github.com/pattern-lab/patternlab-node/issues/554)
* [Verify maturity of Twig engine](https://github.com/pattern-lab/patternlab-node/issues/285)

See https://github.com/pattern-lab/the-spec/issues/37 for more info.
12 changes: 6 additions & 6 deletions packages/engine-underscore/README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# The Underscore engine for Pattern Lab / Node
# The Underscore PatternEngine for Pattern Lab / Node

## Installing

To install the Underscore engine in your edition, `npm install patternengine-node-underscore` should do the trick.
To install the Underscore PatternEngine in your edition, `npm install @pattern-lab/engine-underscore` should do the trick.

## Supported features

* [x] [Includes](http://patternlab.io/docs/pattern-including.html) (Accomplished using the included [`_.renderNamedPartial()`](https://github.com/pattern-lab/patternengine-node-underscore/blob/master/lib/engine_underscore.js#L54-L59))
* [x] [Includes](http://patternlab.io/docs/pattern-including.html) (Accomplished using the included [`_.renderNamedPartial()`](https://github.com/pattern-lab/patternlab-node/blob/master/packages/engine-underscore/lib/engine_underscore.js#L54-L60))
* [x] Lineage
* [x] [Hidden Patterns](http://patternlab.io/docs/pattern-hiding.html)
* [x] [Pseudo-Patterns](http://patternlab.io/docs/pattern-pseudo-patterns.html)
* [x] [Pattern States](http://patternlab.io/docs/pattern-states.html)
* [ ] [Pattern Parameters](http://patternlab.io/docs/pattern-parameters.html) (Accomplished instead using parameter object passed to the included [`_.renderNamedPartial()`](https://github.com/pattern-lab/patternengine-node-underscore/blob/master/lib/engine_underscore.js#L54-L59) mixin function)
* [ ] [Style Modifiers](http://patternlab.io/docs/pattern-stylemodifier.html) (Accomplished instead using parameter object passed to the included [`_.renderNamedPartial()`](https://github.com/pattern-lab/patternengine-node-underscore/blob/master/lib/engine_underscore.js#L54-L59) mixin function)
* [ ] [Pattern Parameters](http://patternlab.io/docs/pattern-parameters.html) (Accomplished instead using parameter object passed to the included [`_.renderNamedPartial()`](https://github.com/pattern-lab/patternlab-node/blob/master/packages/engine-underscore/lib/engine_underscore.js#L54-L60) mixin function)
* [ ] [Style Modifiers](http://patternlab.io/docs/pattern-stylemodifier.html) (Accomplished instead using parameter object passed to the included [`_.renderNamedPartial()`](https://github.com/pattern-lab/patternlab-node/blob/master/packages/engine-underscore/lib/engine_underscore.js#L54-L60) mixin function)

## Extensions to basic Underscore functionality

### Pattern including

Underscore templates include no native support for calling other templates, so support for pattern including is accomplished through an included Underscore mixin function, [`_.renderNamedPartial()`](https://github.com/pattern-lab/patternengine-node-underscore/blob/master/lib/engine_underscore.js#L54-L59), and is considered experimental, but seems to work just fine.
Underscore templates include no native support for calling other templates, so support for pattern including is accomplished through an included Underscore mixin function, [`_.renderNamedPartial()`](https://github.com/pattern-lab/patternlab-node/blob/master/packages/engine-underscore/lib/engine_underscore.js#L54-L60), and is considered experimental, but seems to work just fine.

#### Example

Expand Down
Loading

0 comments on commit 4edf0d4

Please sign in to comment.