Merge pull request #192 from waku-org/weboko/update-create-app

fix: update README, fix bin command and bump version
This commit is contained in:
Sasha 2023-01-19 20:13:35 +01:00 committed by GitHub
commit 1b04f9bdaa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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. 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: #### 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", "license": "MIT OR Apache-2.0",
"dependencies": { "dependencies": {
"commander": "^9.4.1", "commander": "^9.4.1",
"enquirer": "^2.3.6",
"fs-extra": "^11.1.0", "fs-extra": "^11.1.0",
"semver": "^7.3.8", "semver": "^7.3.8",
"validate-npm-package-name": "^5.0.0" "validate-npm-package-name": "^5.0.0"
@ -21,6 +22,14 @@
"node": ">=16" "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": { "node_modules/builtins": {
"version": "5.0.1", "version": "5.0.1",
"resolved": "https://registry.npmjs.org/builtins/-/builtins-5.0.1.tgz", "resolved": "https://registry.npmjs.org/builtins/-/builtins-5.0.1.tgz",
@ -37,6 +46,17 @@
"node": "^12.20.0 || >=14" "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": { "node_modules/fs-extra": {
"version": "11.1.0", "version": "11.1.0",
"resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.1.0.tgz", "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.1.0.tgz",
@ -117,6 +137,11 @@
} }
}, },
"dependencies": { "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": { "builtins": {
"version": "5.0.1", "version": "5.0.1",
"resolved": "https://registry.npmjs.org/builtins/-/builtins-5.0.1.tgz", "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", "resolved": "https://registry.npmjs.org/commander/-/commander-9.4.1.tgz",
"integrity": "sha512-5EEkTNyHNGFPD2H+c/dXXfQZYa/scCKasxWcXJaWnNJ99pnQN9Vnmqow+p+PlFPE63Q6mThaZws1T+HxfpgtPw==" "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": { "fs-extra": {
"version": "11.1.0", "version": "11.1.0",
"resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.1.0.tgz", "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.1.0.tgz",

View File

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