# Minorui (A work in progress)

[![0.2.0 NPM Version](https://img.shields.io/badge/npm-v0.2.0-orange)](http://npmjs.com/package/minorui)
[![MIT License Status](https://img.shields.io/badge/license-MIT-blue)](https://github.com/jorenrui/minorui/blob/main/LICENSE)

A React UI component library with a minimal design. The official design system for [Sutle](https://sutle.io).

## Installation

Install `Minorui` using [yarn](https://yarnpkg.com/) or [npm](https://www.npmjs.com/):

```bash
# Using NPM
npm install --save minorui

# Using Yarn
yarn add minorui
```

## Usage

```jsx
import { Heading } from 'minorui';

...

<Heading>
  Hello World
</Heading>
```

## Inspirations/Acknowledgements

### [Tailwind CSS](https://tailwindcss.com/)

I'm not really that great of a thinker when it comes to theme or creating a design system. That is why I decided to use some of Tailwind's styles to built my own custom components. Minorui uses the theming from Tailwind CSS (colors, font sizes, breakpoints, etc.).

### [Radix](https://radix-ui.com/)

I don't really want to reinvent the wheel when it comes to accessibility so I used Radix UI for that.

### [Stitches](stitches.dev/)

A styling library that I am really a fan of. I really love how you can add variants to the styled components. You must check this out 👀

### [Hero Icons](https://heroicons.com/)

I'm currently using Hero Icons, a set of free MIT-licensed svg icons by the makers of Tailwind CSS.

## Changelog

[Changelog](https://github.com/jorenrui/minorui/blob/main/CHANGELOG.md)

## License

MIT © [Joeylene Rivera](https://github.com/jorenrui)