Skip to content
This repository was archived by the owner on Mar 17, 2024. It is now read-only.

Commit 83063f4

Browse files
committed
update README
1 parent 4c28064 commit 83063f4

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

README.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @ts-graphviz/react
22

3-
Graphviz-dot Renderer for React.
3+
Graphviz-dot Renderer using React.
44

55
## Installation
66

@@ -25,20 +25,16 @@ $ npm install @ts-graphviz/react
2525
# Peer Dependencies
2626
$ yarn add react ts-graphviz
2727
# Optional Peer Dependencies
28-
$ yarn add @hpcc-js/wasm
28+
$ yarn add @hpcc-js/wasm react-dom
2929
```
3030

31-
## API
32-
33-
### Core Module
31+
## DEMO
3432

35-
The core is designed to be independent of the execution environment.
33+
- [Storybook](https://ts-graphviz.github.io/react/)
3634

37-
It is designed to work in both browsers and Node.js.
38-
39-
It provides core components and hooks of `@ts-graphviz/react` and render functions.
35+
## API
4036

41-
#### Script
37+
### Script
4238

4339
```tsx
4440
import React, { FC } from 'react';
@@ -81,7 +77,7 @@ const dot = renderToDot(<Example />);
8177
console.log(dot);
8278
```
8379

84-
#### Output dot
80+
### Output dot
8581

8682
```dot
8783
digraph {
@@ -113,9 +109,9 @@ digraph {
113109

114110
![dot](./example/example.svg)
115111

116-
### Web Module
112+
### Web
117113

118-
The `Graphviz` component of `@ts-graphviz/react/web` can be rendered directly in the browser.
114+
The `Graphviz` component can be rendered directly in the browser.
119115

120116
Since this component uses the function of `@hpcc-js/wasm` internally, it is necessary to host `@hpcc-js/wasm/dist/graphviz.wasm` and specify its directory with `wasmFolder`.
121117

0 commit comments

Comments
 (0)