Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: update doc #66

Merged
merged 1 commit into from
Jun 20, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
Loading