Skip to content

Commit 8fca633

Browse files
committed
Update README.md
1 parent 92069f9 commit 8fca633

File tree

2 files changed

+10
-13
lines changed

2 files changed

+10
-13
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![vscode typescript](https://github.com/CodeStix/typed-react-form/raw/master/example/public/thumb.png)
44

5-
A fast, completely type-checked React form state manager, focussed on typescript integration and minimal rerenders. Featuring:
5+
A fast, completely type-checked React form builder, focussed on typescript integration and minimal rerenders. Featuring:
66

77
- [Object fields](https://typed-react-form.codestix.nl/docs/Object-fields)
88
- [Array fields](https://typed-react-form.codestix.nl/docs/Array-fields)
@@ -18,20 +18,18 @@ A fast, completely type-checked React form state manager, focussed on typescript
1818
npm install typed-react-form
1919
```
2020

21-
## [Documentation](https://typed-react-form.codestix.nl/)
22-
23-
**You can find documentation and information on how to get started [here](https://typed-react-form.codestix.nl/).**
21+
## [Documentation here](https://typed-react-form.codestix.nl/)
2422

2523
## Javascript/typescript React
2624

2725
This library is built from the ground up for React with typescript, but it also works with with vanilla React, without enforced type checking.
2826

2927
## Contributing
3028

31-
Contributions are always welcome!
29+
Contributions are welcome.
3230

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

package.json

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"name": "typed-react-form",
33
"version": "1.3.0",
4-
"description": "A React form state manager, focussed on flawless typescript integration and minimal rerenders.",
5-
"author": "CodeStix",
4+
"description": "A React form form builder, focussed on typescript integration and minimal rerenders.",
5+
"author": "codestix",
66
"license": "MIT",
77
"repository": "CodeStix/typed-react-form",
88
"homepage": "https://typed-react-form.codestix.nl/",
@@ -11,11 +11,10 @@
1111
"keywords": [
1212
"react",
1313
"form",
14-
"state-manager",
15-
"react-form",
14+
"react form",
15+
"type checked form",
1616
"typescript",
17-
"react-typescript",
18-
"tsx",
17+
"react typescript",
1918
"typescript form"
2019
],
2120
"engines": {
@@ -51,4 +50,4 @@
5150
"**/@typescript-eslint/eslint-plugin": "^4.15.1",
5251
"**/@typescript-eslint/parser": "^4.15.1"
5352
}
54-
}
53+
}

0 commit comments

Comments
 (0)