Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update documentation links in README.md #330

Merged
merged 1 commit into from
May 31, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 9 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,64 +1,19 @@
# Open UI
## Getting Started

Open UI is a powerful design system created with Shadcn UI and Tailwind CSS. It is designed to make it easy to use and facilitate the development of new projects. Our team has put in a lot of effort to create this design system, and we welcome contributions and ideas for improvement. We value your feedback and would love to hear from you.
Visit <a aria-label="openui learn" href="https://openui-org.vercel.app/docs/getting-started/installation">https://openui-org.vercel.app/docs/getting-started/installation</a> to get started with Open UI.

## Features

- Built with [Shadcn UI](https://https://ui.shadcn.com/) and [Tailwind CSS](https://tailwindcss.com/)
- Customizable
- Dark mode support
- [Figma Kit](https://www.figma.com/community/file/1354464067434498042)

## Components

_General_

- [x] Button
- [x] Aspect Ratio
- [x] Carousel

_Data Input_

- [x] Input
- [x] Label
- [x] Select
- [x] Checkbox
- [x] Slider

_Layout_

- [x] Separator

_Display_

- [x] Card
- [x] Avatar
- [x] Accordion
- [x] Alert
- [x] Badge
- [x] Tooltips
- [x] Tables

_Navigation_

- [x] Tabs
- [x] Breadcrumb
- [x] Dropdown
- [x] Sheet
## Documentation

_Loading_
Visit [https://openui-org.vercel.app/docs](https://openui-org.vercel.app/docs) to view the full documentation.

- [x] Dialog
- [x] Progress
- [x] Skeleton
- [x] Popover
## Contributing

## Documentation
Contributions are always welcome!

If you want to know more about this design system visit
See [CONTRIBUTING.md](https://github.com/OpenLabs-dev/openui/blob/main/CONTRIBUTING.md) for ways to get started.

- [Documentation](https://openui-org.vercel.app)
Please adhere to this project's [CODE_OF_CONDUCT](https://github.com/OpenLabs-dev/openui/blob/main/CODE_OF_CONDUCT.md).

## License

[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
[MIT](https://choosealicense.com/licenses/mit/)
Loading