Skip to content
This repository was archived by the owner on Apr 6, 2023. It is now read-only.

Commit b814b14

Browse files
committed
docs: Create Readme for all packages
1 parent e9c8b1d commit b814b14

4 files changed

Lines changed: 115 additions & 56 deletions

File tree

README.md

Lines changed: 0 additions & 56 deletions
This file was deleted.

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
packages/core/README.md

packages/core/README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<p align="center">
2+
<a href="https://unform.dev">
3+
<img src="https://storage.googleapis.com/golden-wind/unform/unform.svg" height="150" width="175" alt="Unform" />
4+
</a>
5+
</p>
6+
7+
<p align="center">Easy peasy highly scalable ReactJS & React Native forms! 🚀</p>
8+
9+
<div align="center">
10+
11+
[![npm](https://img.shields.io/npm/v/@unform/core.svg?color=%238257E5&style=for-the-badge)](https://www.npmjs.com/package/@unform/core)<space><space>
12+
[![Coverage Status](https://img.shields.io/coveralls/github/unform/unform?color=8257E5&style=for-the-badge)](https://coveralls.io/github/unform/unform?branch=main)
13+
14+
</div>
15+
16+
## Overview
17+
18+
Unform is a performance-focused API for creating powerful forms experiences for both React and React Native. Using hooks, you can build lightweight and composable forms based on ultra-extensible components. Integrate with any form library, validate your fields, and have your data out of the box.
19+
20+
- **[Getting started](https://unform.dev/quick-start)**
21+
- **[Installation](https://unform.dev/installation)**
22+
23+
Want to test Unform before using it?
24+
25+
- **[React Playground](https://codesandbox.io/embed/agitated-tdd-uf177?autoresize=1&expanddevtools=1&fontsize=14&hidenavigation=1&theme=dark)**
26+
- **[React Native Playground](https://snack.expo.io/@diego3g/1e9fb3)**
27+
28+
_ps: not available with React Native Web or Expo Web, use the iOS/Android devices in Expo Snack._
29+
30+
## Need help?
31+
32+
We’re using [GitHub Discussions](https://github.com/unform/unform/discussions) to create conversations around Unform. It is a place for our community to connect with each other around ideas, questions, issues, and suggestions.
33+
34+
## Roadmap
35+
36+
If Unform currently doesn't have a certain feature you think it's awesome, be sure to check out the [roadmap](https://www.notion.so/Unform-public-roadmap-e4dff9e2053c4475b162cd19914eab02) to see if this is already planned for the future. Otherwise, we recommend you [create a discussion](https://github.com/unform/unform/discussions/new?category=ideas) describing your enhancement request.
37+
38+
## Contributing
39+
40+
Thank you for being interested in making this package better. We encourage everyone to help improve this project with new features, bug fixes, or performance improvements. Please take a little bit of your time to read our guide to make this process faster and easier.
41+
42+
### Contribution Guidelines
43+
44+
To understand how to submit an issue, commit and create pull requests, check our [Contribution Guidelines](/.github/CONTRIBUTING.md).
45+
46+
### Code of Conduct
47+
48+
We expect you to follow our [Code of Conduct](/.github/CODE_OF_CONDUCT.md). You can read it to understand what kind of behavior will and will not be tolerated.
49+
50+
## License
51+
52+
MIT © [Rocketseat](https://github.com/Rocketseat)

packages/mobile/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<p align="center">
2+
<a href="https://unform.dev">
3+
<img src="https://storage.googleapis.com/golden-wind/unform/unform.svg" height="150" width="175" alt="Unform" />
4+
</a>
5+
</p>
6+
7+
<p align="center">Unform for React Native</p>
8+
9+
<div align="center">
10+
11+
[![npm](https://img.shields.io/npm/v/@unform/mobile.svg?color=%238257E5&style=for-the-badge)](https://www.npmjs.com/package/@unform/mobile)<space><space>
12+
[![Coverage Status](https://img.shields.io/coveralls/github/unform/unform?color=8257E5&style=for-the-badge)](https://coveralls.io/github/unform/unform?branch=main)
13+
14+
</div>
15+
16+
## Overview
17+
18+
Unform is a performance-focused API for creating powerful forms experiences for both React and React Native. Using hooks, you can build lightweight and composable forms based on ultra-extensible components. Integrate with any form library, validate your fields, and have your data out of the box.
19+
20+
- **[Getting started](https://unform.dev/guides/react-native)**
21+
- **[Installation](https://unform.dev/installation)**
22+
23+
Want to test Unform for React Native before using it? [Click here](https://snack.expo.io/@diego3g/1e9fb3) and try it on Snack. Make sure to use the iOS/Android devices, currently Unform is not available for React Native Web or Expo Web.
24+
25+
## Need help?
26+
27+
We’re using [GitHub Discussions](https://github.com/unform/unform/discussions) to create conversations around Unform. It is a place for our community to connect with each other around ideas, questions, issues, and suggestions.
28+
29+
## License
30+
31+
MIT © [Rocketseat](https://github.com/Rocketseat)

packages/web/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<p align="center">
2+
<a href="https://unform.dev">
3+
<img src="https://storage.googleapis.com/golden-wind/unform/unform.svg" height="150" width="175" alt="Unform" />
4+
</a>
5+
</p>
6+
7+
<p align="center">Unform for React</p>
8+
9+
<div align="center">
10+
11+
[![npm](https://img.shields.io/npm/v/@unform/web.svg?color=%238257E5&style=for-the-badge)](https://www.npmjs.com/package/@unform/web)<space><space>
12+
[![Coverage Status](https://img.shields.io/coveralls/github/unform/unform?color=8257E5&style=for-the-badge)](https://coveralls.io/github/unform/unform?branch=main)
13+
14+
</div>
15+
16+
## Overview
17+
18+
Unform is a performance-focused API for creating powerful forms experiences for both React and React Native. Using hooks, you can build lightweight and composable forms based on ultra-extensible components. Integrate with any form library, validate your fields, and have your data out of the box.
19+
20+
- **[Getting started](https://unform.dev/quick-start)**
21+
- **[Installation](https://unform.dev/installation)**
22+
23+
Want to test Unform before using it? [Click here](https://codesandbox.io/embed/agitated-tdd-uf177?autoresize=1&expanddevtools=1&fontsize=14&hidenavigation=1&theme=dark) and try it on CodeSandbox.
24+
25+
## Need help?
26+
27+
We’re using [GitHub Discussions](https://github.com/unform/unform/discussions) to create conversations around Unform. It is a place for our community to connect with each other around ideas, questions, issues, and suggestions.
28+
29+
## License
30+
31+
MIT © [Rocketseat](https://github.com/Rocketseat)

0 commit comments

Comments
 (0)