Skip to content

Commit 805034d

Browse files
author
Nick Ardecky
committed
doc: Update docs
- update readme with proper module path - update package.json to have a homepage url
1 parent 34331bc commit 805034d

3 files changed

Lines changed: 6 additions & 3 deletions

File tree

.github/workflows/publish-to-npm.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ name: Publish to NPM
66
# only run when a release has been "published"
77
on:
88
release:
9-
types: [published]
9+
types: [released]
1010

1111
jobs:
1212

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,11 @@ In your main html file, include the package as a script include.
6666
<script src="/path/to/zingchart-react.js"></script>
6767
```
6868

69-
### `zingchart` Global Objects
69+
### `zingchart` Global Object
7070

71-
If you need access to the `window.zingchart` objects for licensing or development flags.
71+
If you need access to the `window.zingchart` objects for licensing or development flags or any top level
72+
variables for other modules like `zingchart.loadGeoJSON()`. This is all exposed by importing the library as
73+
the `zingchart` variable with `import zingchart from 'zingchart/es6'`.
7274

7375
```javascript
7476
import zingchart from 'zingchart/es6';

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
"main": "dist/zingchart-react.js",
99
"module": "dist/zingchart-react.es.js",
1010
"jsnext:main": "dist/zingchart-react.es.js",
11+
"homepage": "https://www.zingchart.com/",
1112
"engines": {
1213
"node": ">=8",
1314
"npm": ">=5"

0 commit comments

Comments
 (0)