Skip to content

Commit 4edf0d4

Browse files
committed
fix(README): update content for consistency
part of #815
1 parent 9abb8ac commit 4edf0d4

File tree

10 files changed

+61
-313
lines changed

10 files changed

+61
-313
lines changed

packages/engine-handlebars/README.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
# The Handlebars engine for Pattern Lab / Node
1+
# The Handlebars PatternEngine for Pattern Lab / Node
22

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

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

packages/engine-liquid/README.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,22 @@
1-
# The Liquid engine for Pattern Lab / Node
1+
# The Liquid PatternEngine for Pattern Lab / Node
22

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

55
## Installing
66

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

109
## Supported features
1110

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

14-
- [x] [Includes](http://patternlab.io/docs/pattern-including.html)
15-
- [x] Lineage
13+
* [x] [Includes](http://patternlab.io/docs/pattern-including.html)
14+
* [x] Lineage
1615

1716
**TBD**
1817

19-
- [ ] [Hidden Patterns](http://patternlab.io/docs/pattern-hiding.html)
20-
- [ ] [Pseudo-Patterns](http://patternlab.io/docs/pattern-pseudo-patterns.html)
21-
- [ ] [Pattern States](http://patternlab.io/docs/pattern-states.html)
22-
- [ ] [Pattern Parameters](http://patternlab.io/docs/pattern-parameters.html)
23-
- [ ] [Style Modifiers](http://patternlab.io/docs/pattern-stylemodifier.html)
18+
* [ ] [Hidden Patterns](http://patternlab.io/docs/pattern-hiding.html)
19+
* [ ] [Pseudo-Patterns](http://patternlab.io/docs/pattern-pseudo-patterns.html)
20+
* [ ] [Pattern States](http://patternlab.io/docs/pattern-states.html)
21+
* [ ] [Pattern Parameters](http://patternlab.io/docs/pattern-parameters.html)
22+
* [ ] [Style Modifiers](http://patternlab.io/docs/pattern-stylemodifier.html)

packages/engine-mustache/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## The Mustache engine for Pattern Lab / Node
1+
## The Mustache PatternEngine for Pattern Lab / Node
22

3-
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).
3+
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).
44

5-
If it's missing from your project for any reason, `npm install patternengine-node-mustache` should do the trick.
5+
If it's missing from your project for any reason, `npm install @pattern-lab/engine-mustache` should do the trick.

packages/engine-react/README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1-
# The React engine for Pattern Lab / Node
1+
# The React PatternEngine for Pattern Lab / Node
22

3-
This is the **very preliminary** React engine for Patternlab/Node.
3+
This is the **very preliminary** React PatternEngine for Patternlab / Node.
44

55
## Status
66

77
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.
88

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

11-
## Supported Pattern Lab
11+
## Installing
12+
13+
To install the React PatternEngine in your edition, `npm install @pattern-lab/engine-react` should do the trick.
14+
15+
## Supported features
1216

1317
* [x] [Includes](http://patternlab.io/docs/pattern-including.html)
1418
* [x] Data inheritance: This can be achieved by combining react `props` & `defaultProps`

packages/engine-twig/README.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
1-
## The Twig engine for Pattern Lab / Node
1+
## The Twig PatternEngine for Pattern Lab / Node
22

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

5-
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.
5+
## Supported features
6+
7+
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.
8+
9+
We are looking for help with the following issues:
10+
11+
* [Pattern Lab does not support twig extends](https://github.com/pattern-lab/patternlab-node/issues/554)
12+
* [Verify maturity of Twig engine](https://github.com/pattern-lab/patternlab-node/issues/285)
13+
14+
See https://github.com/pattern-lab/the-spec/issues/37 for more info.

packages/engine-underscore/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
1-
# The Underscore engine for Pattern Lab / Node
1+
# The Underscore PatternEngine for Pattern Lab / Node
22

33
## Installing
44

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

77
## Supported features
88

9-
* [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))
9+
* [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))
1010
* [x] Lineage
1111
* [x] [Hidden Patterns](http://patternlab.io/docs/pattern-hiding.html)
1212
* [x] [Pseudo-Patterns](http://patternlab.io/docs/pattern-pseudo-patterns.html)
1313
* [x] [Pattern States](http://patternlab.io/docs/pattern-states.html)
14-
* [ ] [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)
15-
* [ ] [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)
14+
* [ ] [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)
15+
* [ ] [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)
1616

1717
## Extensions to basic Underscore functionality
1818

1919
### Pattern including
2020

21-
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.
21+
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.
2222

2323
#### Example
2424

0 commit comments

Comments
 (0)