-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Added basic readme for ui project
- Loading branch information
1 parent
d5bad1c
commit 0ee1427
Showing
2 changed files
with
42 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters