Skip to content

Commit

Permalink
chore: add FAQ section and remove local usage warning
Browse files Browse the repository at this point in the history
  • Loading branch information
bonanaaaaaa committed Apr 10, 2024
1 parent 8bd3a0b commit 15a644c
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,6 @@ To install the Amity UI-Kit together with another project, follow these steps:
pnpm i file:<path-to-amity-ui-kit-repository>
```

Please note that this installation process is intended for local development environments. If you wish to publish your custom open-source project, you will need to create and publish a new npm package independently.

## Documentation

For detailed information and guidance on using the Amity UI-Kit, please refer to our comprehensive online documentation available at [https://docs.amity.co](https://docs.amity.co).
Expand All @@ -76,3 +74,15 @@ If you require further assistance or have any questions, please don't hesitate t
We welcome contributions from the community to help improve and enhance the Amity UI-Kit. If you are interested in contributing to this project, please review our [contributing guide](https://github.com/AmityCo/Amity-Social-Cloud-UIKit-Web-OpenSource/blob/develop/contributing.md) for guidelines and best practices.

Thank you for choosing the Amity UI-Kit for your web development needs!

### FAQ

Q: I tried to run `pnpm build` and it throws a types error.
A: Try to structure your project to be like this:

```
- your_app
- src
- Amity-Social-Cloud-UIKit-Web-OpenSource
- src
```

0 comments on commit 15a644c

Please sign in to comment.