Skip to content
This repository was archived by the owner on Feb 29, 2024. It is now read-only.

Commit 8b744fd

Browse files
committed
moved on with README
1 parent 50a931d commit 8b744fd

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,22 @@
11
# [@cat-react](https://github.com/cat-react) / form ![Build Status](https://travis-ci.org/cat-react/form.svg?branch=master) [![codecov](https://codecov.io/gh/cat-react/form/branch/master/graph/badge.svg)](https://codecov.io/gh/cat-react/form)
22
A simple yet powerful library which helps creating validated forms in react.
33

4-
# License
4+
## Getting Started
5+
Are you looking for a simple way to create validated forms with React?
6+
Congratulations! Your search is over, because `@cat-react/form` offers you a simple way to create either frontend- or backend-validated forms.
7+
8+
## Installation
9+
10+
## Contribution
11+
The project requires at least the latest stable version of node and npm.
12+
13+
Two simple steps to get the things running on your local machine:
14+
- Fork the repo
15+
- Execute `yarn`
16+
17+
You can run the examples with `yarn run examples` and the tests with `yarn test`.
18+
19+
## License
520
[MIT License](/LICENSE)
621

722
Copyright (c) 2017 Catalysts GmbH

0 commit comments

Comments
 (0)