Skip to content

Commit

Permalink
Update engine requirements and deps
Browse files Browse the repository at this point in the history
  • Loading branch information
aduh95 committed Jun 16, 2019
1 parent 01d681b commit 4f07e0b
Show file tree
Hide file tree
Showing 3 changed files with 128 additions and 158 deletions.
25 changes: 13 additions & 12 deletions README.md
@@ -1,26 +1,27 @@
# yUML to SVG

This branch is a experiment for ES dynamic modules. Only works with Node 10+.
This branch is a experiment for ES dynamic modules. Only works with Node 10 LTS
and Node 12+.

## Installation

You can install it with yarn:

```bash
yarn global add yuml2svg # For CLI usage
yarn add yuml2svg # As local dependency
yarn global add yuml2svg@beta # For CLI usage
yarn add yuml2svg@beta # As local dependency
```

Or with npm:

```bash
npm --global install yuml2svg # For CLI usage
npm install yuml2svg --save # As local dependency
npm --global install yuml2svg@beta # For CLI usage
npm install yuml2svg@beta --save # As local dependency
```

## Features

* Embedded rendering engine: **No need to call an external web service**
- Embedded rendering engine: **No need to call an external web service**

## yUML syntax

Expand Down Expand Up @@ -64,12 +65,12 @@ as a `string`.

> The options for the rendering are:
>
> * `dir`: `string` The direction of the diagram "TB" (default) - topDown,
> - `dir`: `string` The direction of the diagram "TB" (default) - topDown,
> "LR" - leftToRight, "RL" - rightToLeft
> * `type`: `string` The type of SVG - "class" (default), "usecase", "activity",
> - `type`: `string` The type of SVG - "class" (default), "usecase", "activity",
> "state", "deployment", "package", "sequence".
> * `isDark`: `boolean` Option to get dark or light diagram
> * `dotHeaderOverrides`: `object` Option to customize output (not supported for
> - `isDark`: `boolean` Option to get dark or light diagram
> - `dotHeaderOverrides`: `object` Option to customize output (not supported for
> sequence diagram)
>
> Please check out [Viz.js wiki](//github.com/mdaines/viz.js/wiki/2.0.0-API) to
Expand Down Expand Up @@ -191,8 +192,8 @@ You can find a working example of a browser implementation using webpack here:
## Credits

* Thanks to the [mdaines](//github.com/mdaines)'s port of
- Thanks to the [mdaines](//github.com/mdaines)'s port of
[Graphviz](//www.graphviz.org/) for JavaScript
[viz.js](//github.com/mdaines/viz.js).
* Thanks to the [jaime-olivares](//github.com/jaime-olivares)'s
- Thanks to the [jaime-olivares](//github.com/jaime-olivares)'s
[VSCode extension](//github.com/jaime-olivares/vscode-yuml).
8 changes: 4 additions & 4 deletions package.json
Expand Up @@ -2,7 +2,7 @@
"name": "yuml2svg",
"displayName": "yUML to SVG",
"description": "UML diagramming tool based on the yUML syntax",
"version": "5.0.0",
"version": "5.0.0-beta.3",
"license": "MIT",
"repository": {
"type": "git",
Expand All @@ -12,7 +12,7 @@
"url": "https://github.com/aduh95/yuml2svg/issues"
},
"engines": {
"node": ">=10.0.0"
"node": "^10.17.0 || >=12.3.0"
},
"categories": [
"Programming Languages",
Expand Down Expand Up @@ -41,11 +41,11 @@
"viz.js": "^2.0.0"
},
"devDependencies": {
"@types/node": "^11.13.8",
"@types/node": "^12.0.8",
"babel-eslint": "^10.0.1",
"eslint": "^5.8.0",
"eslint-config-defaults": "^9.0.0",
"eslint-config-prettier": "^4.2.0",
"eslint-config-prettier": "^5.0.0",
"eslint-plugin-prettier": "^3.0.0",
"prettier": "1.14.3"
}
Expand Down

0 comments on commit 4f07e0b

Please sign in to comment.