Skip to content

Commit

Permalink
fix: update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
topAmity committed Jun 20, 2024
1 parent deea53c commit dd89a82
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <path-to-your-app>
```

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:<path-to-amity-ui-kit-repository> --save
npm i file:<path-to-amity-ui-kit-repository>/<path-to-tgz-file> --save
```
- Yarn (Classic):
```
yarn add file:<path-to-amity-ui-kit-repository>
yarn add file:<path-to-amity-ui-kit-repository>/<path-to-tgz-file>
```
- PNPM:
```
pnpm i file:<path-to-amity-ui-kit-repository>
pnpm i file:<path-to-amity-ui-kit-repository>/<path-to-tgz-file>
```
## Documentation
Expand Down Expand Up @@ -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.

0 comments on commit dd89a82

Please sign in to comment.