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

Commit fa00871

Browse files
committed
README update
1 parent a85b1cf commit fa00871

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,23 @@
11
# patternengine-node-react
2-
The React engine for Patternlab/Node
2+
The (**very preliminary almost not-working-at-all**) React engine for Patternlab/Node
3+
4+
## Status
5+
You can author standalone React components that include only the main React module, which I know isn't much yet. We're still working out how React components will resolve and load the modules they depend on, including other patterns. We believe this is tricky, but doable.
6+
7+
## Supported features
8+
Kind of nothing works yet. **Very early in development.**
9+
10+
- [ ] [Includes](http://patternlab.io/docs/pattern-including.html)
11+
- [ ] Lineage
12+
- [ ] [Hidden Patterns](http://patternlab.io/docs/pattern-hiding.html)
13+
- [ ] [Pseudo-Patterns](http://patternlab.io/docs/pattern-pseudo-patterns.html)
14+
- [ ] [Pattern States](http://patternlab.io/docs/pattern-states.html)
15+
- [ ] [Pattern Parameters](http://patternlab.io/docs/pattern-parameters.html)
16+
- [ ] [Style Modifiers](http://patternlab.io/docs/pattern-stylemodifier.html)
17+
18+
## Usage
19+
20+
* `*.jsx` files are detected as patterns.
21+
* Standard pattern JSON is passed into React components as props.
22+
* We currently assume the React include (and others, once we figure that out) are written using es2015 module syntax.
23+
* The Babel transforms are currently hard-coded into the engine, but we hope to make this configurable in the future.

0 commit comments

Comments
 (0)