Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chaiwattsw committed Feb 27, 2024
1 parent a0ed2db commit af8d0df
Showing 1 changed file with 0 additions and 13 deletions.
13 changes: 0 additions & 13 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
<<<<<<< HEAD
# Amity Ui-Kit for Web (open-source)
=======
# Amity Ui-Kit for Web
>>>>>>> upstream/release/3.1.3

## Getting started

### Installation

<<<<<<< HEAD
Here are the steps to install ui-kit together with another project.

1. git clone [email protected]:AmityCo/Amity-Social-Cloud-UIKit-Web-OpenSource.git
Expand All @@ -21,19 +16,11 @@ Here are the steps to install ui-kit together with another project.
8. npm link @amityco/ui-kit-open-source --save

** We need to link react module to react module in destination project so that react is the same instance otherwise we will encounter [issues with react hook](https://medium.com/bbc-product-technology/solving-the-problem-with-npm-link-and-react-hooks-266c832dd019).
=======
1. `npm install --save @amityco/ui-kit`
2. `yarn add @amityco/ui-kit`
>>>>>>> upstream/release/3.1.3

### Documentation

Please refer to our online documentation at https://docs.amity.co or contact a Ui-Kit representative at **[email protected]** for support.

## Contributing

<<<<<<< HEAD
See [our contributing guide](https://github.com/EkoCommunications/AmityUiKitWeb/blob/develop/CONTRIBUTING.md)
=======
See [our contributing guide](https://github.com/EkoCommunications/AmityUiKitWeb/blob/develop/CONTRIBUTING.md)
>>>>>>> upstream/release/3.1.3

0 comments on commit af8d0df

Please sign in to comment.