From 15db43927c8068a3bf8ce68e5c76199ef96d4e6d Mon Sep 17 00:00:00 2001 From: topAmity <112688936+topAmity@users.noreply.github.com> Date: Thu, 20 Jun 2024 16:26:46 +0700 Subject: [PATCH] fix: update doc (#66) --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9dc1f30c..8a1abc28 100644 --- a/README.md +++ b/README.md @@ -82,24 +82,30 @@ To install the Amity UI-Kit together with another project, follow these steps: pnpm run build ``` -5. Navigate to your application's directory: +5. Pack the project + + ``` + pnpm pack + ``` + +6. Navigate to your application's directory: ``` cd ``` -6. Link the Amity UI-Kit repository to your application using one of the following package managers: +7. Install the Amity UI-Kit to your application using one of the following package managers: - NPM: ``` - npm link file: --save + npm i file:/ --save ``` - Yarn (Classic): ``` - yarn add file: + yarn add file:/ ``` - PNPM: ``` - pnpm i file: + pnpm i file:/ ``` ## Documentation @@ -127,4 +133,4 @@ A: Try to structure your project to be like this: ``` Q: The modifications I made to the code do not appear to be applied. -A: Please attempt to execute `npm cache clean` or `npm cache clean --force` to resolve this issue. +A: Please attempt to execute `npm cache clean` or `npm cache clean --force` to resolve this issue. \ No newline at end of file