From 75d7b16cfb1ff28106508e5ee21deba9fc93a657 Mon Sep 17 00:00:00 2001 From: weboko Date: Tue, 6 Dec 2022 23:18:55 +0100 Subject: [PATCH] add basic README --- packages/create-waku-app/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/packages/create-waku-app/README.md b/packages/create-waku-app/README.md index e69de29..6427100 100644 --- a/packages/create-waku-app/README.md +++ b/packages/create-waku-app/README.md @@ -0,0 +1,12 @@ +## @waku/create-app + +This package is here to help you bootstrap your next Waku dapp. + +Usage: +- `yarn create @waku/app [options] ` +- `npx @waku/create-app [options] ` + +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. \ No newline at end of file