update README, bump version and fix bin command

This commit is contained in:
weboko 2023-01-19 20:05:59 +01:00
parent a0ff2445b8
commit 29f5441731
No known key found for this signature in database
3 changed files with 77 additions and 44 deletions

View File

@ -9,4 +9,4 @@ Usage:
For options you can specify template from which to initialize your app. Template correlates directly to the name of example you can see in this repository.
#### How to add support for new example:
Extend `wakuExamples` property defined in `package.json` in this package with the name of the example and relative path to it where folder of the example should be the same as it's name.
Just create an example in the `examples` folder in the root of the repository.

View File

@ -10,6 +10,7 @@
"license": "MIT OR Apache-2.0",
"dependencies": {
"commander": "^9.4.1",
"enquirer": "^2.3.6",
"fs-extra": "^11.1.0",
"semver": "^7.3.8",
"validate-npm-package-name": "^5.0.0"
@ -21,6 +22,14 @@
"node": ">=16"
}
},
"node_modules/ansi-colors": {
"version": "4.1.3",
"resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.3.tgz",
"integrity": "sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw==",
"engines": {
"node": ">=6"
}
},
"node_modules/builtins": {
"version": "5.0.1",
"resolved": "https://registry.npmjs.org/builtins/-/builtins-5.0.1.tgz",
@ -37,6 +46,17 @@
"node": "^12.20.0 || >=14"
}
},
"node_modules/enquirer": {
"version": "2.3.6",
"resolved": "https://registry.npmjs.org/enquirer/-/enquirer-2.3.6.tgz",
"integrity": "sha512-yjNnPr315/FjS4zIsUxYguYUPP2e1NK4d7E7ZOLiyYCcbFBiTMyID+2wvm2w6+pZ/odMA7cRkjhsPbltwBOrLg==",
"dependencies": {
"ansi-colors": "^4.1.1"
},
"engines": {
"node": ">=8.6"
}
},
"node_modules/fs-extra": {
"version": "11.1.0",
"resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.1.0.tgz",
@ -117,6 +137,11 @@
}
},
"dependencies": {
"ansi-colors": {
"version": "4.1.3",
"resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.3.tgz",
"integrity": "sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw=="
},
"builtins": {
"version": "5.0.1",
"resolved": "https://registry.npmjs.org/builtins/-/builtins-5.0.1.tgz",
@ -130,6 +155,14 @@
"resolved": "https://registry.npmjs.org/commander/-/commander-9.4.1.tgz",
"integrity": "sha512-5EEkTNyHNGFPD2H+c/dXXfQZYa/scCKasxWcXJaWnNJ99pnQN9Vnmqow+p+PlFPE63Q6mThaZws1T+HxfpgtPw=="
},
"enquirer": {
"version": "2.3.6",
"resolved": "https://registry.npmjs.org/enquirer/-/enquirer-2.3.6.tgz",
"integrity": "sha512-yjNnPr315/FjS4zIsUxYguYUPP2e1NK4d7E7ZOLiyYCcbFBiTMyID+2wvm2w6+pZ/odMA7cRkjhsPbltwBOrLg==",
"requires": {
"ansi-colors": "^4.1.1"
}
},
"fs-extra": {
"version": "11.1.0",
"resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.1.0.tgz",

View File

@ -1,45 +1,45 @@
{
"name": "@waku/create-app",
"version": "0.1.0",
"description": "Helper package to bootstrap Waku app ",
"repository": {
"type": "git",
"url": "https://github.com/waku-org/js-waku-examples.git",
"directory": "packages/create-app"
},
"engines": {
"node": ">=16"
},
"bugs": {
"url": "https://github.com/waku-org/js-waku-examples/issues"
},
"files": [
"index.js",
"createApp.js",
"examples"
],
"main": "index.js",
"bin": {
"create-waku-app": "./index.js"
},
"scripts": {
"build": "node ./build.js",
"prepublishOnly": "npm run build"
},
"keywords": [
"waku",
"decentralised",
"communication",
"web3",
"ethereum",
"dapps"
],
"license": "MIT OR Apache-2.0",
"dependencies": {
"commander": "^9.4.1",
"enquirer": "^2.3.6",
"fs-extra": "^11.1.0",
"semver": "^7.3.8",
"validate-npm-package-name": "^5.0.0"
}
"name": "@waku/create-app",
"version": "0.1.1",
"description": "Helper package to bootstrap Waku app ",
"repository": {
"type": "git",
"url": "https://github.com/waku-org/js-waku-examples.git",
"directory": "packages/create-app"
},
"engines": {
"node": ">=16"
},
"bugs": {
"url": "https://github.com/waku-org/js-waku-examples/issues"
},
"files": [
"index.js",
"createApp.js",
"examples"
],
"main": "index.js",
"bin": {
"create-app": "./index.js"
},
"scripts": {
"build": "node ./build.js",
"prepublishOnly": "npm run build"
},
"keywords": [
"waku",
"decentralised",
"communication",
"web3",
"ethereum",
"dapps"
],
"license": "MIT OR Apache-2.0",
"dependencies": {
"commander": "^9.4.1",
"enquirer": "^2.3.6",
"fs-extra": "^11.1.0",
"semver": "^7.3.8",
"validate-npm-package-name": "^5.0.0"
}
}