Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ivanmiletic committed Sep 18, 2023
1 parent 06efa6e commit 263177b
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,29 @@
## BETA JDM Editor

JDM Editor is an open-source React component for crafting and designing JDM (JSON Decision model) files.

> A JDM Editor
> Live demo and usage at https://gorules.github.io/jdm-editor/
## Installation
```bash
npm i @gorules/jdm-editor
```

## Usage
```typescript
<JdmConfigProvider>
<DecisionGraph
value={graph}
onChange={(val) => setGraph(val as any)}
/>
</JdmConfigProvider>
```

## Decision Graph

<img width="945" alt="Rules Engine Editor" src="https://user-images.githubusercontent.com/60513195/224425568-4a717e34-3d4b-4cc6-b031-8cd35f8ff459.png">

```typescript
export type DecisionGraphProps = {
id?: string;
Expand All @@ -25,7 +44,7 @@ export type DecisionGraphProps = {

## Decision Table

<img width="945" alt="Rules Engine Editor" src="https://github.com/gorules/jdm-editor/assets/60513195/8db213d7-0b59-4969-a7d8-afaffd1c5a85">
<img width="945" alt="Decision Table Editor" src="https://github.com/gorules/jdm-editor/assets/60513195/8db213d7-0b59-4969-a7d8-afaffd1c5a85">

### API

Expand Down

0 comments on commit 263177b

Please sign in to comment.