Skip to content

Commit

Permalink
Update READMEs and add project classification (#48)
Browse files Browse the repository at this point in the history
Update outdated README sections and add project classification
  • Loading branch information
ndoschek committed Jun 30, 2023
1 parent 207816e commit 8f7dbf6
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 22 deletions.
2 changes: 1 addition & 1 deletion Jenkinsfile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ kind: Pod
spec:
containers:
- name: node
image: eclipsetheia/theia-blueprint
image: eclipsetheia/theia-blueprint:builder
tty: true
resources:
limits:
Expand Down
35 changes: 20 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,38 @@
# Eclipse EMF.cloud JSONForms property-view for Eclipse Theia applications ![build-status](https://img.shields.io/jenkins/build?jobUrl=https://ci.eclipse.org/emfcloud/job/eclipse-emfcloud/job/jsonforms-property-view/job/master/)

# Eclipse EMF.cloud JSONForms property-view for Eclipse Theia applications

[![Aim - Framework](https://img.shields.io/badge/Aim-Framework-brightgreen)](https://github.com/eclipsesource/.github/blob/main/repository-classification.md)
[![Project - Maintenance](https://img.shields.io/badge/Project-Maintenance-872ea4)](https://github.com/eclipsesource/.github/blob/main/repository-classification.md)
![build-status](https://img.shields.io/jenkins/build?jobUrl=https://ci.eclipse.org/emfcloud/job/eclipse-emfcloud/job/jsonforms-property-view/job/master/)
[![License: EPL v2.0](https://img.shields.io/badge/License-EPL%20v2.0-yellow.svg)](https://www.eclipse.org/legal/epl-2.0/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

This repository contains a framework. It is meant as a library or platform for implementing certain features or types of products, or can be used as a product directly. It is designed to be reusable, customizable, and ready for production.

This repository is in maintenance mode. The maintainers will focus on issues relevant to their adoption use cases only.

For more information, please visit the [EMF.cloud Website](https://www.eclipse.org/emfcloud/).

If you are interested in adopting this framework for your product or enhancing its feature spectrum, please get in contact with us using the [discussions forum](https://github.com/eclipse-emfcloud/emfcloud/discussions) and have a look at our [support options](https://www.eclipse.org/emfcloud/contact/)!

## Available via NPM ![build-status-server](https://img.shields.io/jenkins/build?jobUrl=https://ci.eclipse.org/emfcloud/job/deploy-jsonforms-property-view-npm/&label=publish)
- https://www.npmjs.com/package/@eclipse-emfcloud/jsonforms-property-view
- https://www.npmjs.com/package/@eclipse-emfcloud/modelserver-jsonforms-property-view

## Dependencies
[<img src="https://img.shields.io/badge/dynamic/json?color=blue&url=https://raw.githubusercontent.com/eclipse-emfcloud/theia-tree-editor/master/theia-tree-editor/package.json&query=$.dependencies%5B%27%40jsonforms%2Fcore%27%5D&label=JSONForms&logo=JSONForms" alt="JSONForms"/>](https://github.com/eclipsesource/jsonforms)
[<img src="https://img.shields.io/badge/dynamic/json?color=blue&url=https://raw.githubusercontent.com/eclipse-emfcloud/theia-tree-editor/master/theia-tree-editor/package.json&query=$.dependencies%5B%27%40theia%2Fcore%27%5D&label=Theia&logo=Theia" alt="Theia"/>](https://github.com/eclipse-theia/theia)
- <https://www.npmjs.com/package/@eclipse-emfcloud/jsonforms-property-view>
- <https://www.npmjs.com/package/@eclipse-emfcloud/modelserver-jsonforms-property-view>

## Project structure

### [`@eclipse-emfcloud/jsonforms-property-view`](./jsonforms-property-view/README.md)

This package provides a framework to integrate a form-based property-view using JSONForms in an Eclipse Theia application.
For more details on the Eclipse Theia property-view please visit the `@theia/property-view` [documentation](https://github.com/eclipse-theia/theia/tree/master/packages/property-view).

### [`@eclipse-emfcloud/modelserver-jsonforms-property-view`](./modelserver-jsonforms-property-view/README.md)

This package provides a [Model Server](https://github.com/eclipse-emfcloud/emfcloud-modelserver) aware version of the jsonforms-property-view.

### [`example/person-detail-property-view`](./example/person-detail-property-view)
This basic development example uses the jsonforms-property-view in a minimal Eclipse Theia browser application.

For more information, please visit the [EMF.cloud Website](https://www.eclipse.org/emfcloud/).
If you have questions, contact us on our [discussions page](https://github.com/eclipse-emfcloud/emfcloud/discussions)
and have a look at our [communication and support options](https://www.eclipse.org/emfcloud/contact/).
This basic development example uses the jsonforms-property-view in a minimal Eclipse Theia browser application.

## Preview

Expand All @@ -40,8 +46,8 @@ Install [nvm](https://github.com/creationix/nvm#install-script).

Install npm and node.

nvm install 12.19.1
nvm use 12.19.1
nvm install 16
nvm use 16

Install yarn.

Expand All @@ -55,14 +61,13 @@ Install dependencies and build framework and example

yarn start


The example browser app runs at [http://localhost:3000](http://localhost:3000).

## License

This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0 which is available at
http://www.eclipse.org/legal/epl-2.0.
<http://www.eclipse.org/legal/epl-2.0>.

This Source Code may also be made available under the following Secondary
Licenses when the conditions for such availability set forth in the Eclipse
Expand Down
4 changes: 2 additions & 2 deletions jsonforms-property-view/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ This package provides a framework to integrate a form-based property-view using
For more details on the Eclipse Theia property-view please visit the [`@theia/property-view` documentation](https://github.com/eclipse-theia/theia/tree/master/packages/property-view).

For more information, please visit the [EMF.cloud Website](https://www.eclipse.org/emfcloud/).
If you have questions, contact us on our [spectrum chat](https://spectrum.chat/emfcloud/)
If you have questions, contact us on our [discussions page](https://github.com/eclipse-emfcloud/emfcloud/discussions)
and have a look at our [communication and support options](https://www.eclipse.org/emfcloud/contact/).

## License

This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0 which is available at
http://www.eclipse.org/legal/epl-2.0.
<http://www.eclipse.org/legal/epl-2.0>.

This Source Code may also be made available under the following Secondary
Licenses when the conditions for such availability set forth in the Eclipse
Expand Down
5 changes: 2 additions & 3 deletions modelserver-jsonforms-property-view/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
# ModelServer aware JSONForms property-view for Eclipse Theia applications


This package provides a [Model Server](https://github.com/eclipse-emfcloud/emfcloud-modelserver) aware version of the `@eclipse-emfcloud/jsonforms-property-view`.

For more information, please visit the [EMF.cloud Website](https://www.eclipse.org/emfcloud/).
If you have questions, contact us on our [spectrum chat](https://spectrum.chat/emfcloud/)
If you have questions, contact us on our [discussions page](https://github.com/eclipse-emfcloud/emfcloud/discussions)
and have a look at our [communication and support options](https://www.eclipse.org/emfcloud/contact/).

## License

This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0 which is available at
http://www.eclipse.org/legal/epl-2.0.
<http://www.eclipse.org/legal/epl-2.0>.

This Source Code may also be made available under the following Secondary
Licenses when the conditions for such availability set forth in the Eclipse
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"license": "(EPL-2.0 OR MIT)",
"engines": {
"yarn": "1.0.x || >=1.2.1",
"node": "^14.15.0 || >=16.0.0"
"node": ">=16.0.0"
},
"scripts": {
"prepare": "lerna run prepare",
Expand Down

0 comments on commit 8f7dbf6

Please sign in to comment.