Skip to content
This repository was archived by the owner on Dec 10, 2019. It is now read-only.

Commit 2bf0ee5

Browse files
authored
Updated README
1 parent 828a7c6 commit 2bf0ee5

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

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

3+
## Installing
34
To install the Twig engine in your edition, `npm install patternengine-node-twig` should do the trick.
45

6+
## Stability
7+
This engine is considered experimental. Please try it out and let us know if you run into any problems. We know that some of the more interesting features of Twig are missing or improperly dealt with, but it should basically work.
8+
9+
## Supported features
10+
- [x] [Includes](http://patternlab.io/docs/pattern-including.html)
11+
- [x] Lineage
12+
- [x] [Hidden Patterns](http://patternlab.io/docs/pattern-hiding.html)
13+
- [x] [Pseudo-Patterns](http://patternlab.io/docs/pattern-pseudo-patterns.html)
14+
- [x] [Pattern States](http://patternlab.io/docs/pattern-states.html)
15+
- [ ] [Pattern Parameters](http://patternlab.io/docs/pattern-parameters.html) (Accomplished instead using native Twig include arguments)
16+
- [ ] [Style Modifiers](http://patternlab.io/docs/pattern-stylemodifier.html) (Accomplished instead using native Twig include arguments)
17+
518
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.

0 commit comments

Comments
 (0)