Skip to content

Commit 849abdf

Browse files
author
Martynas Žilinskas
committed
Updated README to all packages.
1 parent 5d49905 commit 849abdf

File tree

4 files changed

+96
-23
lines changed

4 files changed

+96
-23
lines changed

‎README.md

Lines changed: 50 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,61 @@
1-
# @simplr/react-forms
2-
Declarative forms for React.
1+
<div align="center">
2+
<a href="https://github.com/SimplrJS">
3+
<img width="200" src="https://user-images.githubusercontent.com/7989797/27303346-34a5d6fa-5543-11e7-91e8-5b34287d0bc8.png" />
4+
</a>
5+
</div>
6+
<h1 align="center">@simplr/react-forms</h1>
7+
Declarative forms for React. Includes declarative modifiers, normalizers and validators.
38

4-
Includes declarative modifiers, normalizers and validators.
9+
### Packages
10+
11+
| Package | Version | Docs | Description |
12+
|---------|---------|------|-------------|
13+
| [`@simplr/react-forms`](/packages/react-forms) | [![npm](https://img.shields.io/npm/v/@simplr/react-forms.svg?style=flat-square)](https://www.npmjs.com/package/@simplr/react-forms) | TBA | The core |
14+
| [`@simplr/react-forms-dom`](/packages/react-forms-dom) | [![npm](https://img.shields.io/npm/v/@simplr/react-forms-dom.svg?style=flat-square)](https://www.npmjs.com/package/@simplr/react-forms-dom) | TBA | DOM components |
15+
| [`@simplr/react-forms-validation`](/packages/react-forms-validation) | [![npm](https://img.shields.io/npm/v/@simplr/react-forms-validation.svg?style=flat-square)](https://www.npmjs.com/package/@simplr/react-forms-dom) | TBA | Validation |
516

6-
At the moment library is work-in-progress. We will try to document some of the notes here, in GitHub.
7-
Feel free to comment on [PRs](https://github.com/SimplrJS/react-forms/pulls?utf8=%E2%9C%93&q=is%3Apr%20) and open [issues](https://github.com/SimplrJS/react-forms/issues).
817

918
### Development
1019

1120
Latest published version should be in the [master](https://github.com/SimplrJS/react-forms/tree/master) branch.
1221
Development is happening in the [dev](https://github.com/SimplrJS/react-forms/tree/dev) and feature branches.
1322

14-
Development right now is being done by [SimplrJS](https://github.com/SimplrJS) team inside [QuatroDev](http://quatrodev.com):
15-
* [Dovydas](https://twitter.com/dovydasnav) (QuatroDev) [[GH](https://github.com/DovydasNavickas)]
16-
* [Martynas](https://twitter.com/MartinZilinskas) (QuatroDev) [[GH](https://github.com/MartynasZilinskas)]
17-
* [Giedrius](https://twitter.com/Giedrucis) (QuatroDev) [[GH](https://github.com/GiedriusGrabauskas)]
18-
* Deividas (QuatroDev) [[GH](https://github.com/DeividasBakanas)]
23+
<h2 align="center">Core Team</h2>
24+
25+
<table>
26+
<tbody>
27+
<tr>
28+
<td align="center" width="25%" valign="top">
29+
<a href="https://github.com/DovydasNavickas">
30+
<img width="150" height="150" src="https://github.com/DovydasNavickas.png?s=150">
31+
<br>
32+
Dovydas Navickas
33+
</td>
34+
</a>
35+
<td align="center" width="25%" valign="top">
36+
<a href="https://github.com/MartynasZilinskas">
37+
<img width="150" height="150" src="https://github.com/MartynasZilinskas.png?s=150">
38+
<br>
39+
Martynas Žilinskas
40+
</a>
41+
</td>
42+
<td align="center" width="25%" valign="top">
43+
<a href="https://github.com/GiedriusGrabauskas">
44+
<img width="150" height="150" src="https://github.com/GiedriusGrabauskas.png?s=150">
45+
<br>
46+
Giedrius Grabauskas
47+
</a>
48+
</td>
49+
<td align="center" width="25%" valign="top">
50+
<a href="https://github.com/DeividasBakanas">
51+
<img width="150" height="150" src="https://github.com/DeividasBakanas.png?s=150">
52+
<br>
53+
Deividas Bakanas
54+
</a>
55+
</td>
56+
</tr>
57+
</tbody>
58+
</table>
1959

2060
### Notes
2161

‎packages/react-forms-dom/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<div align="center">
2+
<a href="https://github.com/SimplrJS">
3+
<img width="200" src="https://user-images.githubusercontent.com/7989797/27303346-34a5d6fa-5543-11e7-91e8-5b34287d0bc8.png" />
4+
</a>
5+
</div>
6+
<p align="center">
7+
<a href="https://npmjs.org/package/@simplr/react-forms-dom">
8+
<img src="https://img.shields.io/npm/v/@simplr/react-forms-dom.svg?style=flat-square" alt="version" />
9+
</a>
10+
<a href="https://npmjs.org/package/@simplr/react-forms-dom">
11+
<img src="https://img.shields.io/npm/l/@simplr/react-forms-dom.svg?style=flat-square" alt="license" />
12+
</a>
13+
</p>
14+
15+
<h1 align="center">@simplr/react-forms-dom</h1>
16+
17+
DOM implementation for `@simplr/react-forms`.

‎packages/react-forms-validation/README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
1-
<p align="right">
2-
<a href="https://npmjs.org/package/simplr-validation">
3-
<img src="https://img.shields.io/npm/v/simplr-validation.svg?style=flat-square" alt="version" />
1+
<div align="center">
2+
<a href="https://github.com/SimplrJS">
3+
<img width="200" src="https://user-images.githubusercontent.com/7989797/27303346-34a5d6fa-5543-11e7-91e8-5b34287d0bc8.png" />
4+
</a>
5+
</div>
6+
<p align="center">
7+
<a href="https://npmjs.org/package/@simplr/react-forms/validation">
8+
<img src="https://img.shields.io/npm/v/@simplr/react-forms-validation.svg?style=flat-square" alt="version" />
49
</a>
5-
<a href="https://npmjs.org/package/simplr-validation">
6-
<img src="https://img.shields.io/npm/l/simplr-validation.svg?style=flat-square" alt="license" />
10+
<a href="https://npmjs.org/package/@simplr/react-forms/validation">
11+
<img src="https://img.shields.io/npm/l/@simplr/react-forms-validation.svg?style=flat-square" alt="license" />
712
</a>
813
</p>
914

10-
<h1 align="center">simplr-validation</h1>
11-
12-
_This readme is WIP. There may be some inconsistency._
15+
<h1 align="center">@simplr/react-forms-validation</h1>
1316

1417
This package subscribes to `@simplr/react-forms` store and it will validate on emitted actions.
1518

@@ -23,16 +26,16 @@ This package subscribes to `@simplr/react-forms` store and it will validate on e
2326
To initialise module you need to import subscriber once in your app.
2427

2528
```typescript
26-
import { Subscriber } from "simplr-validation";
29+
import { InitializeValidation } from "@simplr/react-forms-validation";
2730

28-
Subscriber.SubscriberContainer;
31+
InitializeValidation();
2932
```
3033

3134
## Validators example
3235

3336
```tsx
3437
import { Form, Text, Password } from "@simplr/react-forms-dom";
35-
import { RequiredValidator, EmailValidator } from "simplr-validation/validators";
38+
import { RequiredValidator, EmailValidator } from "@simplr/react-forms-validation";
3639

3740
export function LoginForm(props: {}) {
3841
return <Form>

‎packages/react-forms/README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,17 @@
1-
@simplr/react-forms
2-
=================
1+
<div align="center">
2+
<a href="https://github.com/SimplrJS">
3+
<img width="200" src="https://user-images.githubusercontent.com/7989797/27303346-34a5d6fa-5543-11e7-91e8-5b34287d0bc8.png" />
4+
</a>
5+
</div>
6+
<p align="center">
7+
<a href="https://npmjs.org/package/@simplr/react-forms">
8+
<img src="https://img.shields.io/npm/v/@simplr/react-forms.svg?style=flat-square" alt="version" />
9+
</a>
10+
<a href="https://npmjs.org/package/@simplr/react-forms">
11+
<img src="https://img.shields.io/npm/l/@simplr/react-forms.svg?style=flat-square" alt="license" />
12+
</a>
13+
</p>
14+
15+
<h1 align="center">@simplr/react-forms</h1>
316

417
The core functionality of forms library.

0 commit comments

Comments
 (0)