From 0ee142788af2cfecaca251447b44901d9cd5cf2e Mon Sep 17 00:00:00 2001
From: "eric.crowell" <eric.crowell@ecrow.dev>
Date: Mon, 17 Jun 2024 13:12:36 +0200
Subject: [PATCH] docs: Added basic readme for ui project

---
 packages/ui/README.md    | 38 ++++++++++++++++++++++++++++++++++++++
 packages/ui/package.json |  5 ++++-
 2 files changed, 42 insertions(+), 1 deletion(-)
 create mode 100644 packages/ui/README.md

diff --git a/packages/ui/README.md b/packages/ui/README.md
new file mode 100644
index 0000000..7219ffb
--- /dev/null
+++ b/packages/ui/README.md
@@ -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
+```
\ No newline at end of file
diff --git a/packages/ui/package.json b/packages/ui/package.json
index 381a26f..9248caf 100644
--- a/packages/ui/package.json
+++ b/packages/ui/package.json
@@ -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",