You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-4Lines changed: 19 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,12 +9,19 @@ This javascript module aims at providing an easy interface in order to represent
9
9
10
10
## Installation
11
11
12
-
With npm : `npm install treeviz`
12
+
With npm :
13
13
14
-
and then you can use it with : `import {Treeviz} from 'treeviz';`
14
+
```Bash
15
+
npm install treeviz
16
+
```
17
+
18
+
and then you can use it with :
19
+
20
+
```JavaScript
21
+
import {Treeviz} from'treeviz';
22
+
```
15
23
16
-
Or download this repository and link the dist/index.js file in your page directly : `<script src="./dist/index.js><script>`
17
-
Also, but not recommended, you can use : `<script src="https://rawgit.com/PierreCapo/treeviz/master/dist/index.js"></script>`
24
+
Or download this zip repository in the Github Release section and link the dist/treeviz.js file in your page directly : `<script src="./dist/index.js><script>`
18
25
19
26
## Usage
20
27
@@ -116,6 +123,14 @@ The table below lists all the avalaible key that the config object can have
116
123
|`marginLeft`| number | 1.25 | Set the margin between the SVG element and the tree |
117
124
|`marginRight`| number | 1.25 | Set the margin between the SVG element and the tree |
118
125
|`duration`| number | 600 | The duration of the animation transition between layouts |
126
+
127
+
## Contributing
128
+
129
+
- Clone the repo.
130
+
- Run `npm install`.
131
+
- Run `npm run dev`, then you can edit the files in the `./src` folder and the `./example/index.html` file.
132
+
- To publish (admin rights), run `npm run build && npm publish`.
133
+
119
134
## Credits
120
135
121
136
This module is based on d3 library, credit to all the contributors of this project.
0 commit comments