Skip to content

Commit 3d45422

Browse files
committed
Add warning in README
1 parent 31086b9 commit 3d45422

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,13 @@ https://bhch.github.io/react-json-form/playground/
1212

1313
https://bhch.github.io/react-json-form/
1414

15+
### ⚠️ Important notes
16+
17+
1. **Consider this library as a work-in-progress** (at least until version 3 which will be a more stable release).
18+
2. Currently, this library doesn't provide default CSS styles. So, you're required to write
19+
your own CSS styles. You can also copy the styles from the demo page (see [`docs.css` after `Line 433`](https://github.com/bhch/react-json-form/blob/master/docs/static/css/docs.css#L433)) as a starting point.
20+
3. Be prepared for breaking changes regarding UI structure and CSS class names. Currently, CSS class names don't
21+
follow a particular naming standard. But this will change in v3.
22+
4. Support for UI themes will be added soon.
23+
1524
[npm]: https://www.npmjs.com/package/@bhch/react-json-form/

0 commit comments

Comments
 (0)