Skip to content

Commit a5557d3

Browse files
authored
Update README.md
1 parent bc08bad commit a5557d3

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,23 @@
1-
# Typed React form [![NPM](https://img.shields.io/npm/v/typed-react-form.svg)](https://www.npmjs.com/package/typed-react-form) [![NPM Size](https://img.shields.io/bundlephobia/minzip/typed-react-form)](https://bundlephobia.com/result?p=typed-react-form)
21

32

3+
<h1 align="center" width="100%">
4+
Typed React form
5+
</h1>
6+
47
<p align="center" width="100%">
58
<img src="https://github.com/CodeStix/typed-react-form/raw/master/docs/images/thumbextrasmall.png">
69
</p>
710

8-
A fast, completely type-checked React form builder, focussed on typescript integration and minimal rerenders. Featuring:
11+
<p align="center" width="100%">
12+
<a href="https://www.npmjs.com/package/typed-react-form"><img alt="NPM" src="https://img.shields.io/npm/v/typed-react-form.svg" /></a>
13+
<a href="https://bundlephobia.com/result?p=typed-react-form"><img alt="NPM Size" src="https://img.shields.io/bundlephobia/minzip/typed-react-form" /></a>
14+
</p>
915

10-
- [Object fields](https://codestix.github.io/typed-react-form/advanced/Object-fields)
11-
- [Array fields](https://codestix.github.io/typed-react-form/advanced/Array-fields)
12-
- [Validation](https://codestix.github.io/typed-react-form/validation)
13-
- [Easily toggle fields](https://codestix.github.io/typed-react-form/advanced/Toggling-a-field)
14-
- [Listeners (subscription based state updates)](https://codestix.github.io/typed-react-form/reference/useListener)
1516

16-
**All of this while keeping type-checking!**
17+
- ✔️ **Completly type-checked**: make less errors, this library was built for Typescript. Supports nested objects/arrays.
18+
- 🤔 **Simple**: An intuitive, unclottered and easy to understand api. Well [documented](https://codestix.github.io/typed-react-form/) too (+JSDoc).
19+
- :fire: **Fast**: only rerenders the fields that change. This allows you to create huge forms.
20+
- 📦 **Pretty Small**: [![NPM Size](https://img.shields.io/bundlephobia/minzip/typed-react-form)](https://bundlephobia.com/result?p=typed-react-form)
1721

1822
## Install
1923

@@ -33,7 +37,7 @@ Contributions are welcome.
3337

3438
1. Clone this repo
3539
2. Install deps using `yarn`. Yarn is required because of the resolutions field in package.json, npm does not support this.
36-
3. Open a new terminal and navigate to `example/`, run `yarn` and `yarn start` to start the testing application.
40+
3. Open a new terminal and navigate to `testing/`, run `yarn` and `yarn start` to start the testing application.
3741
4. Done! When you edit source code, it will be rebuilt and update the testing application.
3842

3943
## License

0 commit comments

Comments
 (0)