From 620ca62fca76a6de993c5be0d38681ad020362bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edgar=20M=C3=BCller?= Date: Fri, 11 May 2018 17:41:29 +0200 Subject: [PATCH] Update Angular READMEs with npm private info (#966) --- packages/angular-material/README.md | 6 +++--- packages/angular/README.md | 7 ++++--- packages/core/README.md | 2 +- packages/editor/README.md | 2 +- packages/i18n/README.md | 2 +- packages/material/README.md | 2 +- packages/react/README.md | 2 +- packages/test/README.md | 2 +- packages/vanilla/README.md | 2 +- packages/webcomponent/README.md | 2 +- 10 files changed, 15 insertions(+), 14 deletions(-) diff --git a/packages/angular-material/README.md b/packages/angular-material/README.md index 9d99e2880..312cd00e3 100644 --- a/packages/angular-material/README.md +++ b/packages/angular-material/README.md @@ -1,12 +1,12 @@ # JSONForms - More Forms. Less Code ### Complex Forms in the blink of an eye -JSONForms eliminates the tedious task of writing fully-featued forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript. +JSONForms eliminates the tedious task of writing fully-featured forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript. # Angular Material Renderers Package -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). +**NOTE**: This is a **private** package as it is still work-in-progress. -**This is a proof of concept currently and will evolve in the future.** +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). # 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. diff --git a/packages/angular/README.md b/packages/angular/README.md index 5a1c9a0c5..663144f4d 100644 --- a/packages/angular/README.md +++ b/packages/angular/README.md @@ -1,14 +1,15 @@ # JSONForms - More Forms. Less Code ### Complex Forms in the blink of an eye -JSONForms eliminates the tedious task of writing fully-featued forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript. +JSONForms eliminates the tedious task of writing fully-featured forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript. # Angular Package +**NOTE**: This is a **private** package as it is still work-in-progress. + This is the JSONForms Angular package which provides the necessary bindings for Angular. It uses [JSONForms Core](https://www.npmjs.com/package/@jsonforms/core). -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). +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). -**This is a proof of concept currently and will evolve in the future.** # 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. diff --git a/packages/core/README.md b/packages/core/README.md index 17c1efe85..de3ed9aba 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -1,7 +1,7 @@ # JSONForms - More Forms. Less Code ### Complex Forms in the blink of an eye -JSONForms eliminates the tedious task of writing fully-featued forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript. +JSONForms eliminates the tedious task of writing fully-featured forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript. # Core Package This is the JSONForms core package. This package provides basic functionality needed to render forms and is based on [Redux](https://redux.js.org/). diff --git a/packages/editor/README.md b/packages/editor/README.md index dee08972c..b9ec65177 100644 --- a/packages/editor/README.md +++ b/packages/editor/README.md @@ -1,7 +1,7 @@ # JSONForms - More Forms. Less Code ### Complex Forms in the blink of an eye -JSONForms eliminates the tedious task of writing fully-featued forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript. +JSONForms eliminates the tedious task of writing fully-featured forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript. # Editor Package This repository contains a re-usable tree component that renders a tree-master-detail JSON editor. diff --git a/packages/i18n/README.md b/packages/i18n/README.md index cdfbfa327..df231131f 100644 --- a/packages/i18n/README.md +++ b/packages/i18n/README.md @@ -1,7 +1,7 @@ # JSONForms - More Forms. Less Code ### Complex Forms in the blink of an eye -JSONForms eliminates the tedious task of writing fully-featued forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript. +JSONForms eliminates the tedious task of writing fully-featured forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript. # I18n Package This is the JSONForms i18n package. This package provides reducers and actions to support i18n. diff --git a/packages/material/README.md b/packages/material/README.md index ce7351066..7257510ce 100644 --- a/packages/material/README.md +++ b/packages/material/README.md @@ -1,7 +1,7 @@ # JSONForms - More Forms. Less Code ### Complex Forms in the blink of an eye -JSONForms eliminates the tedious task of writing fully-featued forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript. +JSONForms eliminates the tedious task of writing fully-featured forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript. # Material Renderers Package 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). diff --git a/packages/react/README.md b/packages/react/README.md index 2ce7794a4..a262bf31a 100644 --- a/packages/react/README.md +++ b/packages/react/README.md @@ -1,7 +1,7 @@ # JSONForms - More Forms. Less Code ### Complex Forms in the blink of an eye -JSONForms eliminates the tedious task of writing fully-featued forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript. +JSONForms eliminates the tedious task of writing fully-featured forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript. # React Package This is the JSONForms react package which provides the necessary bindings for React. It uses [JSONForms Core](https://www.npmjs.com/package/@jsonforms/core). diff --git a/packages/test/README.md b/packages/test/README.md index 52521c553..52e3f7184 100644 --- a/packages/test/README.md +++ b/packages/test/README.md @@ -1,7 +1,7 @@ # JSONForms - More Forms. Less Code ### Complex Forms in the blink of an eye -JSONForms eliminates the tedious task of writing fully-featued forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript. +JSONForms eliminates the tedious task of writing fully-featured forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript. # Test Package 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. diff --git a/packages/vanilla/README.md b/packages/vanilla/README.md index 950f9d563..7af7e7305 100644 --- a/packages/vanilla/README.md +++ b/packages/vanilla/README.md @@ -1,7 +1,7 @@ # JSONForms - More Forms. Less Code ### Complex Forms in the blink of an eye -JSONForms eliminates the tedious task of writing fully-featued forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript. +JSONForms eliminates the tedious task of writing fully-featured forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript. # Vanilla Renderers Package 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). diff --git a/packages/webcomponent/README.md b/packages/webcomponent/README.md index 37d9ab182..4c07b331c 100644 --- a/packages/webcomponent/README.md +++ b/packages/webcomponent/README.md @@ -1,7 +1,7 @@ # JSONForms - More Forms. Less Code ### Complex Forms in the blink of an eye -JSONForms eliminates the tedious task of writing fully-featued forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript. +JSONForms eliminates the tedious task of writing fully-featured forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript. # WebComponent Package This is the JSONForms WebComponent package which does not contain any renderers by itself but only a webcomponent wrapper for react-based renderer sets. This wrapper allows you to reuse the renderers in a web component based application.