README.md

sandwich-ui

A tasty React UI kit

Table of Contents

• About
• Getting started
  • Installation
• Using
• Contributing
• License

About

Sandwich UI is a React UI kit used for my personal projects.

This repository is a monorepo, powered by Turborepo.

It is composed of three projects:

• the Sandwich UI library
• the Docs
• the Storybook

Getting started

Installation

# npm
npm install @mrsquaare/sandwich-ui

# yarn
yarn add @mrsquaare/sandwich-ui

# pnpm
pnpm install @mrsquaare/sandwich-ui

Using

import { Button } from "@mrsquaare/sandwich-ui";

function Example() {
  return (
    <Button>Click me</Button>
  );
}

Contributing

Bug reports, feature requests, other issues and pull requests are welcome. See CONTRIBUTING.md for more information.

License

Distributed under the ISC License. See LICENSE for more information.