@crossed/ui/README.md

A universal & performant styling library for React Native, Next.js & React

<h1 style="border-bottom: 0; font-size: 5rem; ">@Crossed/ui</h1>

## Introduction

@Crossed/ui is our component package, by instaling it you will be able to use our React components.
A detailed list is available on our [documentation](https://paymium.github.io/crossed/ui/Card)

## Installation

@crossed/ui is made of several React component that you can import one by one by installing @crossed/ui

```
pnpm i @crossed/ui
```

## Getting Strated

All you need to do is import component you want to use from @crossed/ui and use it in your app

```
import { Card,  } from '@crossed/ui`

const YourComponent = () =>{
    return (
        <Card>
            <Card.Title>I'm the card's title</Card.Title>
            <Card.Description>I'm the card's description</Card.Description>
        </Card>
    )
}
```

Go check our [documentation](https://paymium.github.io/crossed/ui/Card) to find more details on how you can use each component

## Contribution

Want to Contribute to our project ? Check our [contribution guide line](../../CONTRIBUTING.MD)