Skip to content

Commit a925bcb

Browse files
committed
Update README.md
1 parent fc298e8 commit a925bcb

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,17 @@ npm install typed-react-form
2828

2929
## [Documentation here](https://codestix.github.io/typed-react-form/)
3030

31+
## Typescript demos
32+
33+
### Type-checked field names
34+
![type-checked field names](https://github.com/CodeStix/typed-react-form/raw/master/docs/images/demo-example.png)
35+
36+
### Type-checked custom inputs
37+
![type-checked custom inputs](https://github.com/CodeStix/typed-react-form/raw/master/docs/images/demo-custom.png)
38+
39+
### Type-checked object/array fields
40+
![type-checked object/array fields](https://github.com/CodeStix/typed-react-form/raw/master/docs/images/demo-objectfield.png)
41+
3142
## Javascript/typescript React
3243

3344
This library is built from the ground up for React with typescript, but it also works with with vanilla React, without enforced type checking.
@@ -38,8 +49,9 @@ Contributions are welcome.
3849

3950
1. Clone this repo.
4051
2. Install deps using `yarn`. Yarn is required because of the resolutions field in package.json, npm does not support this.
41-
3. Open a new terminal and navigate to `testing/`, run `yarn` and `yarn start` to start the testing application.
42-
4. Done! When you edit source code, it will be rebuilt and update the testing application.
52+
3. Run `yarn start`, this will watch source files in `src/` and rebuild on change.
53+
4. Open a new terminal and navigate to `testing/`, run `yarn` and `yarn start` to start the testing application.
54+
5. Done! When you edit source code, it will be rebuilt and update the testing application.
4355

4456
## License
4557

0 commit comments

Comments
 (0)