Skip to content

Commit

Permalink
chore: update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
peterhnm committed Nov 8, 2023
1 parent 6413cb0 commit f47a632
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 22 deletions.
2 changes: 1 addition & 1 deletion apps/miranum-config-editor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ You need to enter the full path to your `JSON Schema` and `UI-Schema` files in t

### Usage

To use the editor, you have to open or create a `.config.json` file.
❗️To use the editor, you have to open or create a `.config.json` file.
The plugin will then search for the `JSON Schema` and `UI-Schema` files in the directory you specified in the settings.
To find the right files, you have to stick to the following naming convention:

Expand Down
14 changes: 7 additions & 7 deletions apps/miranum-console/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,20 +33,20 @@

## About The Project [![Version][version-shield]][version-url] [![Installs][installs-shield]][installs-url]

Miranum IDE is a collection of *VS Code Plugins* that allows you to edit, manage and access all artifacts for your
process application in one place.
> Note: [Miranum IDE](https://marketplace.visualstudio.com/items?itemName=miragon-gmbh.miranum-ide) is a collection of *VS Code Plugins*
> that allows you to edit, manage and access all artifacts for your
> process application in one place.
> **Miranum Console** is one component of *Miranum IDE*.

**Miranum Console** is one component of **Miranum IDE**.
It provides a UI that helps you to scaffold a new digitization project and deploying your process artefacts.
In order to help you with your first steps with **Miranum Console**, we have created tutorials that you can be found [here](https://www.miranum.io/docs/guides/quick-start/miranum-ide/miranum-ide-quickstart).
**Miranum Console** provides a UI that helps you to scaffold a new digitization project and deploy your process artefacts.
To help you get started with **Miranum IDE**, we have created some [quick start guides](https://www.miranum.io/docs/guides/quick-start/miranum-ide/miranum-ide-quickstart).

<img src="https://github.com/Miragon/miranum-ide/blob/main/apps/miranum-console/assets/console.webp?raw=true" alt="console.webp" width="850" /><br>

## Features

* Scaffolding your digitization project.
* Manage your project-files inside a custom tree view.
* Manage your project files inside a custom tree view.
* Deploy your process artefacts.

## Contributing
Expand Down
1 change: 1 addition & 0 deletions apps/miranum-console/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"license": "SEE LICENSE IN LICENSE",
"version": "0.1.0",
"publisher": "miragon-gmbh",
"preview": true,
"homepage": "https://www.miranum.io/",
"galleryBanner": {
"color": "#F0F8FF",
Expand Down
2 changes: 1 addition & 1 deletion apps/miranum-extension-pack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@

Miranum IDE is a collection of *VS Code Plugins* that allows you to edit, manage and access all artifacts for your
process application in one place.
In order to help you with your first steps with **Miranum IDE**, we have created tutorials that you can be found [here](https://www.miranum.io/docs/guides/quick-start/miranum-ide/miranum-ide-quickstart).
To help you get started with **Miranum IDE**, we have created some [quick start guides](https://www.miranum.io/docs/guides/quick-start/miranum-ide/miranum-ide-quickstart).

## Contributing

Expand Down
16 changes: 8 additions & 8 deletions apps/miranum-forms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,14 @@

## About The Project [![Version][version-shield]][version-url] [![Installs][installs-shield]][installs-url]

Miranum IDE is a collection of *VS Code Plugins* that allows you to edit, manage and access all artifacts for your
process application in one place.


**Miranum Forms** is one component of **Miranum IDE**.
It allows you to create and edit forms based on [JSON Schema](https://json-schema.org/),
a specification for annotating and validating JSON documents.
In order to help you with your first steps with **Miranum Forms**, we have created tutorials that you can be found [here](https://www.miranum.io/docs/guides/quick-start/miranum-ide/miranum-ide-quickstart).
> Note: [Miranum IDE](https://marketplace.visualstudio.com/items?itemName=miragon-gmbh.miranum-ide) is a collection of *VS Code Plugins*
> that allows you to edit, manage and access all artifacts for your
> process application in one place.
> **Miranum Forms** is one component of *Miranum IDE*.
**Miranum Forms** allows you to create and edit forms based on [JSON Schema](https://json-schema.org/),
a specification for annotating and validating JSON documents.
To help you get started with **Miranum IDE**, we have created some [quick start guides](https://www.miranum.io/docs/guides/quick-start/miranum-ide/miranum-ide-quickstart).

> ❗️To start the form builder create or open a `.form` file.❗
Expand Down
11 changes: 6 additions & 5 deletions apps/miranum-modeler/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,14 @@

## About The Project [![Version][version-shield]][version-url] [![Installs][installs-shield]][installs-url]

[Miranum IDE](https://marketplace.visualstudio.com/items?itemName=miragon-gmbh.miranum-ide) is a collection of *VS Code Plugins* that allows you to edit, manage and access all artifacts for your
process application in one place.
> Note: [Miranum IDE](https://marketplace.visualstudio.com/items?itemName=miragon-gmbh.miranum-ide) is a collection of *VS Code Plugins*
> that allows you to edit, manage and access all artifacts for your
> process application in one place.
> **Miranum Modeler** is one component of *Miranum IDE*.
**Miranum Modeler** is one component of **Miranum IDE**.
It allows you to model BPMN 2.0 diagrams that can be used with Camunda Platform 7 and 8.
**Miranum Modeler** allows you to model BPMN 2.0 diagrams that can be used with Camunda Platform 7 and 8.
In addition, you can create and edit DMN 1.3 decision tables.
In order to help you with your first steps with **Miranum Modeler**, we have created tutorials that you can be found [here](https://www.miranum.io/docs/guides/quick-start/miranum-ide/miranum-ide-quickstart).
To help you get started with **Miranum IDE**, we have created some [quick start guides](https://www.miranum.io/docs/guides/quick-start/miranum-ide/miranum-ide-quickstart).

> ❗️To start the modeler create or open a `.bpmn` or `.dmn` file.❗
Expand Down

0 comments on commit f47a632

Please sign in to comment.