Skip to content

Commit c6f92eb

Browse files
authored
Merge pull request #732 from rvsia/updateReadme
Update readme
2 parents 8f779ff + 360bab0 commit c6f92eb

File tree

11 files changed

+33
-30
lines changed

11 files changed

+33
-30
lines changed

README.md

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,23 @@ Data Driven Forms is a React library used for rendering and managing forms with
88

99

1010
:question: Why to use Data Driven Forms? :question:
11-
- All forms shared the same functionality!
12-
- Components are controlled in one place!
13-
- You can easily migrate to different sets of components!
14-
- All functionality is provided (see below!)
11+
- All forms **shared** the same **functionality**!
12+
- Components are **controlled** in **one place**!
13+
- You can **easily migrate** to different sets of components!
14+
- All **functionality** is **provided** (see below!)
1515

1616
:tada: Features :tada:
17-
- Easily readable schema, you don't need to know any HTML or JS to be able to write your own form schemas!
18-
- You can use your own components or use one of our provided mappers ([PatternFly 3](https://patternfly-react.surge.sh/patternfly-3/index.html), [PatternFly 4](https://patternfly-react.surge.sh/patternfly-4/), [Material-UI](https://material-ui.com/) or [Ant Design](https://ant.design/)!)
19-
- Form state managing out-of-the-box (including error states!)
20-
- Fully customizable (you can use your own buttons, actions, etc.)!
21-
- Conditional fields!
22-
- Custom field validation with basic set included!
23-
- Datatype validation!
24-
- Cross-field validation!
25-
- Asynchronous validation supported!
26-
- Supporting Wizard forms!
27-
- Supporting [Final Form Field Array](https://github.com/final-form/react-final-form-arrays)!
17+
- **Easily readable schema**, you don't need to know any HTML or JS to be able to write your own form schemas!
18+
- You can use your **own components** or use one of our **provided mappers** ([PatternFly 3](https://patternfly-react.surge.sh/patternfly-3/index.html), [PatternFly 4](https://patternfly-react.surge.sh/patternfly-4/), [Material-UI](https://material-ui.com/), [Ant Design](https://ant.design/)! and more, see below!)
19+
- **Form state manager** out-of-the-box (including error states!)
20+
- Fully **customizable** (you can use your own buttons, actions, etc.)!
21+
- **Conditional** fields!
22+
- Custom field **validation** with basic set included!
23+
- **Datatype** validation!
24+
- **Cross-field** validation!
25+
- **Asynchronous** validation supported!
26+
- Supporting **Wizard** forms!
27+
- Supporting **[Final Form Field Array](https://github.com/final-form/react-final-form-arrays)!**
2828
- ... and a lot more!
2929

3030
:book: For more information please visit the [documentation](https://data-driven-forms.org/). :book:
@@ -38,7 +38,6 @@ Data Driven Forms is a React library used for rendering and managing forms with
3838
- [PatternFly 4 Mapper](#patternfly-4-mapper)
3939
- [BlueprintJS Mapper](#blueprintjs-mapper)
4040
- [Semantic UI Mapper](#semantic-ui-mapper)
41-
- [Material-UI Mapper](#material-ui-mapper)
4241
- [Ant Design Mapper](#ant-design-mapper)
4342
- [Usage](#usage)
4443
- [Custom mapper](#custom-mapper)
@@ -119,9 +118,7 @@ $ npm install @data-driven-forms/suir-component-mapper -S
119118
$ yarn add @data-driven-forms/suir-component-mapper
120119
```
121120

122-
Component libraries in mappers are external dependencies. Make sure to install them in your bundles.
123-
124-
#### [Ant Design Mapper](https://www.npmjs.com/package/@data-driven-forms/ant-component-mapper)
121+
#### [Ant Design Mapper](https://data-driven-forms.org/mappers/ant-component-mapper)
125122

126123
```console
127124
$ npm install @data-driven-forms/ant-component-mapper -S
@@ -131,6 +128,8 @@ $ npm install @data-driven-forms/ant-component-mapper -S
131128
$ yarn add @data-driven-forms/ant-component-mapper
132129
```
133130

131+
Component libraries in mappers are external dependencies. Make sure to install them and their styles in your bundles.
132+
134133
### Usage
135134

136135
In order to Data Driven Forms in your component you need the renderer and a component mapper, which provides component mapper and form template.
@@ -228,18 +227,22 @@ Please use our [documentation site](https://data-driven-forms.org/). In case of
228227
- [PatternFly 4 Design documentation](https://www.patternfly.org/v4/)
229228
- [Material-UI documentation](https://material-ui.com/)
230229
- [Ant Design documentation](https://ant.design/)
230+
- [Semantic UI React](https://react.semantic-ui.com/)
231+
- [BlueprintJS](https://blueprintjs.com/)
231232
- NPM
232233
- [React Form Renderer](https://www.npmjs.com/package/@data-driven-forms/react-form-renderer)
233234
- [PatternFly 3 Mapper](https://www.npmjs.com/package/@data-driven-forms/pf3-component-mapper)
234235
- [PatternFly 4 Mapper](https://www.npmjs.com/package/@data-driven-forms/pf4-component-mapper)
235236
- [MaterialUI Mapper](https://www.npmjs.com/package/@data-driven-forms/mui-component-mapper)
236237
- [Ant Design Mapper](https://www.npmjs.com/package/@data-driven-forms/ant-component-mapper)
238+
- [Semantic UI Mapper](https://www.npmjs.com/package/@data-driven-forms/suir-component-mapper)
239+
- [BlueprintJS Mapper](https://www.npmjs.com/package/@data-driven-forms/blueprint-component-mapper)
237240
- Examples of schemas (PatternFly 3)
238241
- [ManageIQ Form Components](https://github.com/ManageIQ/manageiq-ui-classic/tree/master/app/javascript/components)
239242

240243
### Development setup
241244

242-
Data Driven Forms is a monorepo which uses [Lerna](https://github.com/lerna/lerna), so you can use all its commands as well.
245+
Data Driven Forms is a monorepo that uses [Lerna](https://github.com/lerna/lerna) and [yarn workspaces](https://classic.yarnpkg.com/blog/2017/08/02/introducing-workspaces/), so you can use all its commands as well.
243246

244247
1. Install
245248

packages/ant-component-mapper/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Data Driven Forms supports all kinds of component, basic set is consisted of:
103103

104104
### Development setup
105105

106-
Data Driven Forms is a monorepo which uses [Lerna](https://github.com/lerna/lerna), so you can use all its commands as well.
106+
Data Driven Forms is a monorepo that uses [Lerna](https://github.com/lerna/lerna) and [yarn workspaces](https://classic.yarnpkg.com/blog/2017/08/02/introducing-workspaces/), so you can use all its commands as well.
107107

108108
1. Install
109109

packages/blueprint-component-mapper/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Data Driven Forms supports all kinds of component, basic set is consisted of:
103103

104104
### Development setup
105105

106-
Data Driven Forms is a monorepo which uses [Lerna](https://github.com/lerna/lerna), so you can use all its commands as well.
106+
Data Driven Forms is a monorepo that uses [Lerna](https://github.com/lerna/lerna) and [yarn workspaces](https://classic.yarnpkg.com/blog/2017/08/02/introducing-workspaces/), so you can use all its commands as well.
107107

108108
1. Install
109109

packages/mui-component-mapper/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Data Driven Forms supports all kinds of component, basic set is consisted of:
106106

107107
### Development setup
108108

109-
Data Driven Forms is a monorepo which uses [Lerna](https://github.com/lerna/lerna), so you can use all its commands as well.
109+
Data Driven Forms is a monorepo that uses [Lerna](https://github.com/lerna/lerna) and [yarn workspaces](https://classic.yarnpkg.com/blog/2017/08/02/introducing-workspaces/), so you can use all its commands as well.
110110

111111
1. Install
112112

packages/parsers/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ const Form = () => (
7878

7979
### Development setup
8080

81-
Data Driven Forms is a monorepo which uses [Lerna](https://github.com/lerna/lerna), so you can use all its commands as well.
81+
Data Driven Forms is a monorepo that uses [Lerna](https://github.com/lerna/lerna) and [yarn workspaces](https://classic.yarnpkg.com/blog/2017/08/02/introducing-workspaces/), so you can use all its commands as well.
8282

8383
1. Install
8484

packages/pf3-component-mapper/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Data Driven Forms supports all kinds of component, basic set is consisted of:
102102

103103
### Development setup
104104

105-
Data Driven Forms is a monorepo which uses [Lerna](https://github.com/lerna/lerna), so you can use all its commands as well.
105+
Data Driven Forms is a monorepo that uses [Lerna](https://github.com/lerna/lerna) and [yarn workspaces](https://classic.yarnpkg.com/blog/2017/08/02/introducing-workspaces/), so you can use all its commands as well.
106106

107107
1. Install
108108

packages/pf4-component-mapper/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Data Driven Forms supports all kinds of component, basic set is consisted of:
104104

105105
### Development setup
106106

107-
Data Driven Forms is a monorepo which uses [Lerna](https://github.com/lerna/lerna), so you can use all its commands as well.
107+
Data Driven Forms is a monorepo that uses [Lerna](https://github.com/lerna/lerna) and [yarn workspaces](https://classic.yarnpkg.com/blog/2017/08/02/introducing-workspaces/), so you can use all its commands as well.
108108

109109
1. Install
110110

packages/react-form-renderer/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ Please use our [documentation site](https://data-driven-forms.org/). In case of
225225

226226
### Development setup
227227

228-
Data Driven Forms is a monorepo which uses [Lerna](https://github.com/lerna/lerna), so you can use all its commands as well.
228+
Data Driven Forms is a monorepo that uses [Lerna](https://github.com/lerna/lerna) and [yarn workspaces](https://classic.yarnpkg.com/blog/2017/08/02/introducing-workspaces/), so you can use all its commands as well.
229229

230230
1. Install
231231

packages/react-renderer-demo/src/pages/development-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import DocPage from '@docs/doc-page';
44

55
# Development setup
66

7-
Data Driven Forms is a monorepo which uses [Lerna](https://github.com/lerna/lerna), so you can use all its commands as well.
7+
Data Driven Forms is a monorepo that uses [Lerna](https://github.com/lerna/lerna) and [yarn workspaces](https://classic.yarnpkg.com/blog/2017/08/02/introducing-workspaces/), so you can use all its commands as well.
88

99
## Install
1010

packages/suir-component-mapper/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Data Driven Forms supports all kinds of component, basic set is consisted of:
103103

104104
### Development setup
105105

106-
Data Driven Forms is a monorepo which uses [Lerna](https://github.com/lerna/lerna), so you can use all its commands as well.
106+
Data Driven Forms is a monorepo that uses [Lerna](https://github.com/lerna/lerna) and [yarn workspaces](https://classic.yarnpkg.com/blog/2017/08/02/introducing-workspaces/), so you can use all its commands as well.
107107

108108
1. Install
109109

0 commit comments

Comments
 (0)