-
Notifications
You must be signed in to change notification settings - Fork 5
/
README.md.tpl
32 lines (23 loc) · 913 Bytes
/
README.md.tpl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# {name}
This is just a {name} module copied from {module} v{version}.
This package is generated for simplicity of use.
# Installation
```bash
npm install {name} --save
```
# Usage
The package expects that global `Highcharts` variable is set.
It also doesn't export anything.
Then just require the package if you use common.js
```javascript
require('{name}')
```
Or include the script in your HTML file.
```html
<script src = "node_modules/{name}/index.js">
```
# Generation info
The code for generating the modules is in [this repository](https://github.com/kirjs/publish-highcharts-modules)
# Issues
Issues with the way modules work [should be reported to the Highcharts repository](https://github.com/highslide-software/highcharts.com/issues)
Issues with the way modules were generated [should be reported to publish-highcharts-modules repository](https://github.com/kirjs/publish-highcharts-modules)