Skip to content

Commit fefe3df

Browse files
committed
vizzu npm: add release.md and json
1 parent a490bdd commit fefe3df

File tree

3 files changed

+66
-0
lines changed

3 files changed

+66
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
.vscode
22
.DS_Store
33
build*
4+
release
45
*.lib
56
tmp
67
*.user

project/npm/package.json

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"name": "vizzu",
3+
"description": "Vizzu is a free, open-source Javascript/C++ library utilizing a generic dataviz engine that generates many types of charts and seamlessly animates between them. It can be used to create static charts but more importantly it is designed for building animated data stories and interactive explorers as Vizzu enables showing different perspectives of the data that the viewers can easily follow due to the animation.",
4+
"keywords": [
5+
"chart",
6+
"charts",
7+
"dataviz",
8+
"charting-library",
9+
"dashboard",
10+
"animation",
11+
"storytelling",
12+
"data-visualization",
13+
"data-analysis",
14+
"charting",
15+
"datavisualization"
16+
],
17+
"homepage": "https://lib.vizzuhq.com/",
18+
"url" : "https://github.com/vizzuhq/vizzu-lib/issues",
19+
"email" : "[email protected]",
20+
"license": "Apache-2.0",
21+
"author": "Vizzu Kft.",
22+
"main": "dist/vizzu.min.js",
23+
"repository": {
24+
"type": "git",
25+
"url": "https://github.com/vizzuhq/vizzu-lib.git"
26+
},
27+
"scripts": {
28+
"test": "echo \"See the following guide how to test the project: https://github.com/vizzuhq/vizzu-lib/blob/main/test/test.md\""
29+
}
30+
}

project/release.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Releasing Vizzu
2+
3+
## Releasing npm package
4+
5+
Note: Build and test the project before release.
6+
7+
Create npm package
8+
9+
```
10+
mkdir -p release/vizzu
11+
12+
cp README.md release/vizzu/README.md
13+
cp CHANGELOG.md release/vizzu/CHANGELOG.md
14+
cp project/npm/package.json release/vizzu/package.json
15+
16+
mkdir -p release/vizzu/dist
17+
18+
cp example/lib/cvizzu.wasm release/vizzu/dist/cvizzu.wasm
19+
cp example/lib/vizzu.d.ts release/vizzu/dist/vizzu.d.ts
20+
cp example/lib/vizzu.min.js release/vizzu/dist/vizzu.min.js
21+
```
22+
23+
Set version number
24+
25+
```
26+
cd release/vizzu
27+
npm version $(node ../../build/cmake-wasm/test/vizzutest.js -v|awk -F'-' '{print $1}')
28+
```
29+
30+
Publish npm package
31+
32+
```
33+
npm login
34+
npm publish
35+
```

0 commit comments

Comments
 (0)