From 3b03af5b491d73bec2d4fabebaf6594f56f3f6aa Mon Sep 17 00:00:00 2001 From: Ronan Berder Date: Wed, 7 May 2025 15:12:35 +0800 Subject: [PATCH] Adding README --- LICENSE.md | 21 +++++++++++++++++++++ README.md | 33 ++++++++++++++++++++++++++------- 2 files changed, 47 insertions(+), 7 deletions(-) create mode 100644 LICENSE.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..63b4b68 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) [year] [fullname] + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index e55c1e2..474d404 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,27 @@ -TODO +# Basecoat -- Card (HTML) -- Combobox -- Command -- Tabs -- Aspect ratio??? -- Avatar \ No newline at end of file +A collection of modern UI components built with Tailwind CSS that works with any web stack. Basecoat brings the magic of [shadcn/ui](https://ui.shadcn.com) to traditional web applications, no React required. + +## Features + +- **Lightweight**: no runtime JS, just CSS and tiny Alpine.js scripts for the more interactive components. +- **Easy to use**: add classes like `btn` or `input` and you're done. +- **Framework-agnostic**: works with any backend or frontend stack. +- **Accessible**: components follow accessibility best practices. +- **Dark mode ready**: respects your Tailwind config. +- **Extendable**: tweak styles with Tailwind or CSS variables. +- **Themable**: fully compatible with shadcn/ui themes. +- **Readable**: no class soup, just clean markup. +- **Free and open source**: MIT licensed. + +## Documentation + +Visit [basecoatui.com](https://basecoatui.com). + +## Installation + +Visit [basecoatui.com/installation](https://basecoatui.com/installation) + +## License + +[MIT](/LICENSE.md) \ No newline at end of file