Skip to content

Commit 9c61240

Browse files
eneufeldedgarmueller
authored andcommitted
Updated Readmes (#919)
1 parent 3976855 commit 9c61240

File tree

9 files changed

+116
-18
lines changed

9 files changed

+116
-18
lines changed
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# JSONForms - More Forms. Less Code
2+
### Complex Forms in the blink of an eye
3+
4+
JSONForms eliminates the tedious task of writing fully-featued forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript.
5+
6+
# Angular Material Renderers Package
7+
This is the JSONForms Angular Material Renderers Package. This package only contains renderers and must be combined with [JSONForms Angular](https://github.com/eclipsesource/jsonforms/blob/master/packages/angular).
8+
9+
**This is a proof of concept currently and will evolve in the future.**
10+
11+
# License
12+
The JSONForms project is licensed under the MIT License. See the [LICENSE file](https://github.com/eclipsesource/jsonforms/blob/master/LICENSE) for more information.
13+
14+
# Roadmap
15+
Our current roadmap is available [here](https://github.com/eclipsesource/jsonforms/blob/master/ROADMAP.md).
16+
17+
# Development
18+
JSONForms is developed by [EclipseSource](https://eclipsesource.com).
19+
We are always very happy to have contributions, whether for trivial cleanups or big new features.
20+
21+
# Migration
22+
If you are already using JSONForms 1, check our [migration guide](https://github.com/eclipsesource/jsonforms/blob/master/MIGRATION.md).

packages/angular/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# JSONForms - More Forms. Less Code
2+
### Complex Forms in the blink of an eye
3+
4+
JSONForms eliminates the tedious task of writing fully-featued forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript.
5+
6+
# Angular Package
7+
This is the JSONForms Angular package which provides the necessary bindings for Angular. It uses [JSONForms Core](https://www.npmjs.com/package/@jsonforms/core).
8+
9+
You can combine the Angular package with any angular-based renderer set you want, for example the [Material Renderers](https://github.com/eclipsesource/jsonforms/blob/master/packages/angular-material).
10+
11+
**This is a proof of concept currently and will evolve in the future.**
12+
13+
# License
14+
The JSONForms project is licensed under the MIT License. See the [LICENSE file](https://github.com/eclipsesource/jsonforms/blob/master/LICENSE) for more information.
15+
16+
# Roadmap
17+
Our current roadmap is available [here](https://github.com/eclipsesource/jsonforms/blob/master/ROADMAP.md).
18+
19+
# Development
20+
JSONForms is developed by [EclipseSource](https://eclipsesource.com).
21+
We are always very happy to have contributions, whether for trivial cleanups or big new features.
22+
23+
# Migration
24+
If you are already using JSONForms 1, check our [migration guide](https://github.com/eclipsesource/jsonforms/blob/master/MIGRATION.md).

packages/core/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# JSONForms - More Forms. Less Code
22
### Complex Forms in the blink of an eye
33

4-
JSONForms uses HTML custom elements and eliminates the need to write HTML templates in order to create forms by leveraging the capabilities of JSON and JSON schema.
4+
JSONForms eliminates the tedious task of writing fully-featued forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript.
55

66
# Core Package
7-
This is the JSONForms core package which does not contain any renderers by itself.
7+
This is the JSONForms core package. This package provides basic functionality needed to render forms and is based on [Redux](https://redux.js.org/).
88

9-
You can combine the core package with any renderer you want, for example the [Material Renderers](https://www.npmjs.com/package/@jsonforms/material-renderers) or the [Vanilla Renderers](https://www.npmjs.com/package/@jsonforms/vanilla-renderers).
9+
In order to use JSONForms Core you need to decide which UI framework you would like to use.
10+
11+
JSONForms currently supports [React](https://www.npmjs.com/package/@jsonforms/react). A proof of concept exists for [Angular](https://github.com/eclipsesource/jsonforms/blob/master/packages/angular).
1012

1113
See the [Example Package](https://www.npmjs.com/package/@jsonforms/examples) on how to integrate JSONForms with your application.
1214

@@ -23,4 +25,4 @@ JSONForms is developed by [EclipseSource](https://eclipsesource.com).
2325
We are always very happy to have contributions, whether for trivial cleanups or big new features.
2426

2527
# Migration
26-
If you are already using JSONForms 1, check our [migration guide](https://github.com/eclipsesource/jsonforms/blob/master/MIGRATION.md).
28+
If you are already using JSONForms 1, check our [migration guide](https://github.com/eclipsesource/jsonforms/blob/master/MIGRATION.md).

packages/i18n/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# JSONForms - More Forms. Less Code
2+
### Complex Forms in the blink of an eye
3+
4+
JSONForms eliminates the tedious task of writing fully-featued forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript.
5+
6+
# I18n Package
7+
This is the JSONForms i18n package. This package provides reducers and actions to support i18n.
8+
9+
You can combine this package with any renderer you want, for example the [Material Renderers](https://www.npmjs.com/package/@jsonforms/material-renderers) or the [Vanilla Renderers](https://www.npmjs.com/package/@jsonforms/vanilla-renderers).
10+
11+
See the [Example Package](https://www.npmjs.com/package/@jsonforms/examples) on how to integrate JSONForms with your application.
12+
13+
Check https://www.npmjs.com/search?q=%40jsonforms for all published JSONForms packages.
14+
15+
# License
16+
The JSONForms project is licensed under the MIT License. See the [LICENSE file](https://github.com/eclipsesource/jsonforms/blob/master/LICENSE) for more information.
17+
18+
# Roadmap
19+
Our current roadmap is available [here](https://github.com/eclipsesource/jsonforms/blob/master/ROADMAP.md).
20+
21+
# Development
22+
JSONForms is developed by [EclipseSource](https://eclipsesource.com).
23+
We are always very happy to have contributions, whether for trivial cleanups or big new features.
24+
25+
# Migration
26+
If you are already using JSONForms 1, check our [migration guide](https://github.com/eclipsesource/jsonforms/blob/master/MIGRATION.md).

packages/material/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# JSONForms - More Forms. Less Code
22
### Complex Forms in the blink of an eye
33

4-
JSONForms uses HTML custom elements and eliminates the need to write HTML templates in order to create forms by leveraging the capabilities of JSON and JSON schema.
4+
JSONForms eliminates the tedious task of writing fully-featued forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript.
55

66
# Material Renderers Package
7-
This is the JSONForms Material Renderers Package. This package only contains renderers and must be combined with the [JSONForms Core](https://www.npmjs.com/package/@jsonforms/core).
7+
This is the JSONForms Material Renderers Package. This package only contains renderers and must be combined with [JSONForms React](https://www.npmjs.com/package/@jsonforms/react).
88

9-
You can combine the [JSONForms Core](https://www.npmjs.com/package/@jsonforms/core) with other renderers too, for example with the [Vanilla Renderers](https://www.npmjs.com/package/@jsonforms/vanilla-renderers).
9+
You can combine [JSONForms React](https://www.npmjs.com/package/@jsonforms/react) with other renderers too, for example with the [Vanilla Renderers](https://www.npmjs.com/package/@jsonforms/vanilla-renderers).
1010

1111
Check https://www.npmjs.com/search?q=%40jsonforms for all published JSONForms packages.
1212

@@ -21,4 +21,4 @@ JSONForms is developed by [EclipseSource](https://eclipsesource.com).
2121
We are always very happy to have contributions, whether for trivial cleanups or big new features.
2222

2323
# Migration
24-
If you are already using JSONForms 1, check our [migration guide](https://github.com/eclipsesource/jsonforms/blob/master/MIGRATION.md).
24+
If you are already using JSONForms 1, check our [migration guide](https://github.com/eclipsesource/jsonforms/blob/master/MIGRATION.md).

packages/react/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# JSONForms - More Forms. Less Code
22
### Complex Forms in the blink of an eye
33

4-
JSONForms uses HTML custom elements and eliminates the need to write HTML templates in order to create forms by leveraging the capabilities of JSON and JSON schema.
4+
JSONForms eliminates the tedious task of writing fully-featued forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript.
55

66
# React Package
7-
This is the JSONForms react package which provides the necessary bindings for React.
7+
This is the JSONForms react package which provides the necessary bindings for React. It uses [JSONForms Core](https://www.npmjs.com/package/@jsonforms/core).
88

99
You can combine the react package with any react-based renderer set you want, for example the [Material Renderers](https://www.npmjs.com/package/@jsonforms/material-renderers) or the [Vanilla Renderers](https://www.npmjs.com/package/@jsonforms/vanilla-renderers).
1010

@@ -23,4 +23,4 @@ JSONForms is developed by [EclipseSource](https://eclipsesource.com).
2323
We are always very happy to have contributions, whether for trivial cleanups or big new features.
2424

2525
# Migration
26-
If you are already using JSONForms 1, check our [migration guide](https://github.com/eclipsesource/jsonforms/blob/master/MIGRATION.md).
26+
If you are already using JSONForms 1, check our [migration guide](https://github.com/eclipsesource/jsonforms/blob/master/MIGRATION.md).

packages/test/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# JSONForms - More Forms. Less Code
2+
### Complex Forms in the blink of an eye
3+
4+
JSONForms eliminates the tedious task of writing fully-featued forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript.
5+
6+
# Test Package
7+
This is the JSONForms test package. It can be used for testing packages which do not care about a specific renderer set being used, e.g. the i18n or the webcomponent package.
8+
9+
This package provides:
10+
* `FakeLayout` which wraps all children into a `div` with the className `layout`.
11+
* `FakeControl` which sets the scope of the control as its className
12+
13+
# License
14+
The JSONForms project is licensed under the MIT License. See the [LICENSE file](https://github.com/eclipsesource/jsonforms/blob/master/LICENSE) for more information.
15+
16+
# Roadmap
17+
Our current roadmap is available [here](https://github.com/eclipsesource/jsonforms/blob/master/ROADMAP.md).
18+
19+
# Development
20+
JSONForms is developed by [EclipseSource](https://eclipsesource.com).
21+
We are always very happy to have contributions, whether for trivial cleanups or big new features.
22+
23+
# Migration
24+
If you are already using JSONForms 1, check our [migration guide](https://github.com/eclipsesource/jsonforms/blob/master/MIGRATION.md).

packages/vanilla/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# JSONForms - More Forms. Less Code
22
### Complex Forms in the blink of an eye
33

4-
JSONForms uses HTML custom elements and eliminates the need to write HTML templates in order to create forms by leveraging the capabilities of JSON and JSON schema.
4+
JSONForms eliminates the tedious task of writing fully-featued forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript.
55

66
# Vanilla Renderers Package
7-
This is the JSONForms Vanilla Renderers Package. This package only contains renderers and must be combined with the [JSONForms Core](https://www.npmjs.com/package/@jsonforms/core).
7+
This is the JSONForms Vanilla Renderers Package. This package only contains renderers and must be combined with [JSONForms React](https://www.npmjs.com/package/@jsonforms/react).
88

9-
You can combine the [JSONForms Core](https://www.npmjs.com/package/@jsonforms/core) with other renderers too, for example with the [Material Renderers](https://www.npmjs.com/package/@jsonforms/material-renderers).
9+
You can combine [JSONForms React](https://www.npmjs.com/package/@jsonforms/react) with other renderers too, for example with the [Material Renderers](https://www.npmjs.com/package/@jsonforms/material-renderers).
1010

1111
Check https://www.npmjs.com/search?q=%40jsonforms for all published JSONForms packages.
1212

@@ -21,4 +21,4 @@ JSONForms is developed by [EclipseSource](https://eclipsesource.com).
2121
We are always very happy to have contributions, whether for trivial cleanups or big new features.
2222

2323
# Migration
24-
If you are already using JSONForms 1, check our [migration guide](https://github.com/eclipsesource/jsonforms/blob/master/MIGRATION.md).
24+
If you are already using JSONForms 1, check our [migration guide](https://github.com/eclipsesource/jsonforms/blob/master/MIGRATION.md).

packages/webcomponent/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# JSONForms - More Forms. Less Code
22
### Complex Forms in the blink of an eye
33

4-
JSONForms uses HTML custom elements and eliminates the need to write HTML templates in order to create forms by leveraging the capabilities of JSON and JSON schema.
4+
JSONForms eliminates the tedious task of writing fully-featued forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript.
55

66
# WebComponent Package
77
This is the JSONForms WebComponent package which does not contain any renderers by itself.
88

9-
You can combine the WebComponent package with any react-based renderer set you want, for example the [Material Renderers](https://www.npmjs.com/package/@jsonforms/material-renderers) or the [Vanilla Renderers](https://www.npmjs.com/package/@jsonforms/vanilla-renderers). You will also need the [JSONForms Core](https://www.npmjs.com/package/@jsonforms/core) package.
9+
You can combine the WebComponent package with any react-based renderer set you want, for example the [Material Renderers](https://www.npmjs.com/package/@jsonforms/material-renderers) or the [Vanilla Renderers](https://www.npmjs.com/package/@jsonforms/vanilla-renderers). You will also need the [JSONForms React](https://www.npmjs.com/package/@jsonforms/react) package.
1010

1111
See the [Example Package](https://www.npmjs.com/package/@jsonforms/examples) on how to integrate JSONForms with your application.
1212

@@ -23,4 +23,4 @@ JSONForms is developed by [EclipseSource](https://eclipsesource.com).
2323
We are always very happy to have contributions, whether for trivial cleanups or big new features.
2424

2525
# Migration
26-
If you are already using JSONForms 1, check our [migration guide](https://github.com/eclipsesource/jsonforms/blob/master/MIGRATION.md).
26+
If you are already using JSONForms 1, check our [migration guide](https://github.com/eclipsesource/jsonforms/blob/master/MIGRATION.md).

0 commit comments

Comments
 (0)