From bcca9459f9277624720f9683abceeec6806da461 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Roman=20Jaro=C5=A1?= Date: Sat, 9 Sep 2023 21:19:11 +0200 Subject: [PATCH] Update documentation Change-Id: Ib5f2a7ba239717233534dc15762d72190541bd45 --- README.md | 26 ++++++++++++++++++++++---- source/shared/package.json | 4 +++- 2 files changed, 25 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f48b102..abe51d3 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,25 @@ ## How to start -1. Create context folder and then use it as last argument (use can use `.`) -2. Create file `.npmrc` -3. Paste this content to file `@toolkit:registry=https://npm.romanjaros.dev` -2. Use this `pnpm dlx @toolkit/seedling --name many --port 93 --monorepo T ./build` \ No newline at end of file +1. Create file `.npmrc` +2. Paste content to file `@toolkit:registry=https://npm.romanjaros.dev` +3. Use `pnpm dlx @toolkit/seedling --name hello-world --port 90 --monorepo T ./app` + - instead of `./app` use can use curent folder, `.` or `./` + +## Parameters + +### name +- define application name +- string + +### port +- define port for application when is deployed +- number + +### monorepo +- define if generated structure will be for monorepo +- value `T` = `true` or `F` = `false` + +### context +- last parameter is folder as destination of generated code +- string \ No newline at end of file diff --git a/source/shared/package.json b/source/shared/package.json index 04388fd..8adb84e 100644 --- a/source/shared/package.json +++ b/source/shared/package.json @@ -7,6 +7,8 @@ "dev": "pnpm -r dev" }, "dependencies": {}, - "devDependencies": {}, + "devDependencies": { + "@types/node": "18.11.0" + }, "peerDependencies": {} } \ No newline at end of file