Skip to content

Commit

Permalink
docs: Added basic readme for ui project
Browse files Browse the repository at this point in the history
  • Loading branch information
eric-crowell committed Jun 17, 2024
1 parent d5bad1c commit 0ee1427
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 1 deletion.
38 changes: 38 additions & 0 deletions packages/ui/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<p align="center">
<img
width="256"
src="https://github.com/do-ob-io/shared/blob/main/do-ob-logo-readme.png?raw=true"
alt="do-ob logo"
/>
</p>

# User Interface

A TailwindCSS and NextUI-(Open Source) components library for React projects. This library provides a set of pre-built, UI components to accelerate web application development.

Indended for use with modern ESM TypeScript in other do-ob projects. Documentation is limited at this time.

## Installation

To use the components from this library in your project, follow these steps:

1. Install TailwindCSS and NextUI:

Make sure you have TailwindCSS and NextUI set up in your project. If not, follow their respective installation guides:

* [TailwindCSS Installation Guide](https://tailwindcss.com/docs/installation)
* [NextUI Installation Guide](https://nextui.org/docs/guide/installation)

2. Install the component library:

```bash
npm install @do-ob/ui
```

```bash
pnpm add @do-ob/ui
```

```bash
yarn add @do-ob/ui
```
5 changes: 4 additions & 1 deletion packages/ui/package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
{
"name": "@do-ob/ui",
"version": "0.0.0",
"description": "A TailwindCSS and NextUI (Open Source) components library for React.",
"description": "A TailwindCSS and NextUI (Open Source) components library for React project.",
"type": "module",
"files": [
"dist"
],
"exports": {
".": {
"import": "./dist/index.js",
Expand Down

0 comments on commit 0ee1427

Please sign in to comment.