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.

Sign up for GitHub

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

Update README.md #68

Closed
wants to merge 1 commit into from
Closed

Update README.md #68

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 23 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,36 @@ npm install @agility/plenum-ui
# Using yarn:
yarn add @agility/plenum-ui
```
## Peer Dependencies

Before installing Plenum, please ensure the following peer dependencies are installed in your project as they are crucial for the proper functioning of the components:

| Dependency | Version |
|------------------------|------------|
| @floating-ui/react | ^0.25.0 |
| @headlessui/react | ^1.7.10 |
| @headlessui/tailwindcss| ^0.1.2 |
| @heroicons/react | ^1.0.5 |
| @tabler/icons | ^2.26.0 |
| @tabler/icons-react | ^2.27.0 |
| react-icons | ^4.10.1 |

To install these dependencies, run the following command using npm or yarn:

```bash
npm install @floating-ui/react@^0.25.0 @headlessui/react@^1.7.10 @headlessui/tailwindcss@^0.1.2 @heroicons/react@^1.0.5 @tabler/icons@^2.26.0 @tabler/icons-react@^2.27.0 react-icons@^4.10.1
# or
yarn add @floating-ui/react@^0.25.0 @headlessui/react@^1.7.10 @headlessui/tailwindcss@^0.1.2 @heroicons/react@^1.0.5 @tabler/icons@^2.26.0 @tabler/icons-react@^2.27.0 react-icons@^4.10.1
```


## Usage

Import and use the Plenum components in your React components:

```jsx
import { Component } from "@agility/plenum-ui"
;<Component {...{ ComponentProps }} />
<Component {...{ ComponentProps }} />
```

## Scripts
Expand Down