Skip to content

Commit 2412b61

Browse files
committed
Add README
1 parent 407e094 commit 2412b61

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<h1 align="center">ReactBrightScript</h1>
2+
3+
<div align="center">
4+
React-like framework for Roku
5+
</div>
6+
7+
## Usage
8+
9+
- Copy the files in `components/react` to your project.
10+
- Extend the `React`* components.
11+
- Override component lifecycle functions as needed. `render`, `componentDidUpdate`, `componentWillUnmount`, `shouldComponentUpdate` are available.
12+
- Call `mapFieldsToProps` function to map properties under `m.top` to `m.props`.
13+
- Call `unmountComponent` to unmount a component.
14+
15+
## Caveat
16+
17+
This framework is in beta. Future changes to the framework may not be backwards compatible.
18+
19+
20+
## License
21+
ReactBrightScript is licensed under the
22+
MIT License. See [LICENSE.txt](LICENSE.txt) for details.

0 commit comments

Comments
 (0)