Update Readmes (#873)

eclipsesource · Mar 8, 2018 · 1118467 · 1118467
1 parent 7dff811
commit 1118467
Show file tree

Hide file tree

Showing 7 changed files with 69 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -32,3 +32,5 @@ Current status: [![Build Status](https://travis-ci.org/eclipsesource/jsonforms.s
 # License
 The JSONForms project is licensed under the MIT License. See the [LICENSE file](https://github.com/eclipsesource/jsonforms/blob/master/LICENSE) for more information.
 
+# Migration
+If you are already using JSONForms 1, check our [migration guide](https://github.com/eclipsesource/jsonforms/blob/master/MIGRATION.md).
diff --git a/packages/core/README.md b/packages/core/README.md
@@ -20,3 +20,7 @@ Our current roadmap is available [here](https://github.com/eclipsesource/jsonfor
 
 # Development
 JSONForms is developed by [EclipseSource](https://eclipsesource.com).
+We are always very happy to have contributions, whether for trivial cleanups or big new features.
+
+# Migration
+If you are already using JSONForms 1, check our [migration guide](https://github.com/eclipsesource/jsonforms/blob/master/MIGRATION.md).
diff --git a/packages/examples/README.md b/packages/examples/README.md
@@ -6,7 +6,7 @@ JSONForms uses HTML custom elements and eliminates the need to write HTML templa
 # Examples Package
 This is the examples package which demonstrates how to integrate JSONForms with your application.
 
-You can combine the [JSONForms Core](https://www.npmjs.com/package/@jsonforms/core) with any renderers 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 can combine the [JSONForms Core](https://www.npmjs.com/package/@jsonforms/core) 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).
 
 Check https://www.npmjs.com/search?q=%40jsonforms for all published JSONForms packages.
 
@@ -18,3 +18,4 @@ Our current roadmap is available [here](https://github.com/eclipsesource/jsonfor
 
 # Development
 JSONForms is developed by [EclipseSource](https://eclipsesource.com).
+We are always very happy to have contributions, whether for trivial cleanups or big new features.
diff --git a/packages/material/README.md b/packages/material/README.md
@@ -18,3 +18,7 @@ Our current roadmap is available [here](https://github.com/eclipsesource/jsonfor
 
 # Development
 JSONForms is developed by [EclipseSource](https://eclipsesource.com).
+We are always very happy to have contributions, whether for trivial cleanups or big new features.
+
+# Migration
+If you are already using JSONForms 1, check our [migration guide](https://github.com/eclipsesource/jsonforms/blob/master/MIGRATION.md).
diff --git a/packages/react/README.md b/packages/react/README.md
@@ -0,0 +1,26 @@
+# JSONForms - More Forms. Less Code
+### Complex Forms in the blink of an eye
+
+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.
+
+# React Package
+This is the JSONForms react package which provides the necessary bindings for React.
+
+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).
+
+See the [Example Package](https://www.npmjs.com/package/@jsonforms/examples) on how to integrate JSONForms with your application.
+
+Check https://www.npmjs.com/search?q=%40jsonforms for all published JSONForms packages.
+
+# License
+The JSONForms project is licensed under the MIT License. See the [LICENSE file](https://github.com/eclipsesource/jsonforms/blob/master/LICENSE) for more information.
+
+# Roadmap
+Our current roadmap is available [here](https://github.com/eclipsesource/jsonforms/blob/master/ROADMAP.md).
+
+# Development
+JSONForms is developed by [EclipseSource](https://eclipsesource.com).
+We are always very happy to have contributions, whether for trivial cleanups or big new features.
+
+# Migration
+If you are already using JSONForms 1, check our [migration guide](https://github.com/eclipsesource/jsonforms/blob/master/MIGRATION.md).
diff --git a/packages/vanilla/README.md b/packages/vanilla/README.md
@@ -6,7 +6,7 @@ JSONForms uses HTML custom elements and eliminates the need to write HTML templa
 # Vanilla Renderers Package
 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).
 
-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).
+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).
 
 Check https://www.npmjs.com/search?q=%40jsonforms for all published JSONForms packages.
 
@@ -18,3 +18,7 @@ Our current roadmap is available [here](https://github.com/eclipsesource/jsonfor
 
 # Development
 JSONForms is developed by [EclipseSource](https://eclipsesource.com).
+We are always very happy to have contributions, whether for trivial cleanups or big new features.
+
+# Migration
+If you are already using JSONForms 1, check our [migration guide](https://github.com/eclipsesource/jsonforms/blob/master/MIGRATION.md).
diff --git a/packages/webcomponent/README.md b/packages/webcomponent/README.md
@@ -0,0 +1,26 @@
+# JSONForms - More Forms. Less Code
+### Complex Forms in the blink of an eye
+
+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.
+
+# WebComponent Package
+This is the JSONForms WebComponent package which does not contain any renderers by itself.
+
+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.
+
+See the [Example Package](https://www.npmjs.com/package/@jsonforms/examples) on how to integrate JSONForms with your application.
+
+Check https://www.npmjs.com/search?q=%40jsonforms for all published JSONForms packages.
+
+# License
+The JSONForms project is licensed under the MIT License. See the [LICENSE file](https://github.com/eclipsesource/jsonforms/blob/master/LICENSE) for more information.
+
+# Roadmap
+Our current roadmap is available [here](https://github.com/eclipsesource/jsonforms/blob/master/ROADMAP.md).
+
+# Development
+JSONForms is developed by [EclipseSource](https://eclipsesource.com).
+We are always very happy to have contributions, whether for trivial cleanups or big new features.
+
+# Migration
+If you are already using JSONForms 1, check our [migration guide](https://github.com/eclipsesource/jsonforms/blob/master/MIGRATION.md).