commit 7414dec74563a1e87e10adf715e6def9b1c4c22b Author: Ralph Schuler <48420064+ralphschuler@users.noreply.github.com> Date: Wed Jun 8 22:48:52 2022 +0200 Create README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..63f3d3c --- /dev/null +++ b/README.md @@ -0,0 +1,385 @@ +
+

:construction: flowbite-vue (unreleased) :construction:

+

+ + Flowbite - Tailwind CSS components + +

+

+ Build websites even faster with components on top of Vue and Tailwind CSS +

+

+ + + + + Discord + + + Total Downloads + + + Latest release + + + Licenese + +

+
+ +--- + +### `flowbite-vue` is an open source collection of UI components, built in Vue, with utility classes from Tailwind CSS that you can use as a starting point for user interfaces and websites. + +## Table of Contents + +- [Documentation](#documentation) +- [Getting started](#getting-started) + - [Require via `npm`](#require-via--npm-) + - [Include via CDN](#include-via-cdn) +- [Components](#components) +- [Community](#community) +- [Contributing](#contributing) +- [Figma](#figma) +- [Copyright and license](#copyright-and-license) + +## Documentation + +Documentation for `flowbite-vue` is not yet finished. + +If you want to browse the components, visit [flowbite.com](https://flowbite.com/). + +If you want to learn more about Flowbite, visit [Flowbite docs](https://flowbite.com/getting-started/introduction/). + +## Getting started + +To use `flowbite-vue`, you just need to setup `flowbite` normally and install `flowbite-vue` from `npm`. + +`flowbite` can be included as a plugin into an existing Tailwind CSS project. + +### Require via `npm` + +Make sure that you have Node.js and Tailwind CSS installed. + +1. Install `flowbite` as a dependency using `npm` by running the following command: + +```bash +npm i flowbite flowbite-vue +``` + +2. Require `flowbite` as a plugin inside the `tailwind.config.js` file: + +```javascript +module.exports = { + content: [ + ..., + 'node_modules/flowbite-vue/**/*.{js,jsx,ts,tsx}' + ], + plugins: [..., require('flowbite/plugin')], +}; +``` + +## Components + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
:construction: Alerts:construction: Badge:construction: Breadcrumbs
+ + Tailwind CSS Alerts + + + + Tailwind CSS Badge + + + + Tailwind CSS Breadcrumbs + +
:construction: Buttons:construction: Button group:construction: Cards
+ + Tailwind CSS Buttons + + + + Tailwind CSS Button Group + + + + Tailwind CSS Cards + +
:construction: Dropdown:construction: Forms:construction: List group
+ + Tailwind CSS Dropdown + + + + Tailwind CSS Forms + + + + Tailwind CSS List group + +
:construction: Typography:construction: Modal:construction: Tabs
+ + Tailwind CSS Typography + + + + Tailwind CSS Modal + + + + Tailwind CSS Tabs + +
:construction: Navbar:construction: Pagination:construction: Timeline
+ + Tailwind CSS Navbar + + + + Tailwind CSS Pagination + + + + Tailwind CSS Timeline + +
:construction: Progress bar:construction: Tables:construction: Toast
+ + Tailwind CSS Progress Bar + + + + Tailwind CSS Tables + + + + Tailwind CSS Toast + +
:construction: Tooltips:construction: Datepicker:construction: Spinner
+ + Tailwind CSS Tooltips + + + + Tailwind CSS Datepicker + + + + Tailwind CSS Spinner + +
:construction: Footer:construction: Accordion:construction: Sidebar
+ + Tailwind CSS Footer + + + + Tailwind CSS Accordion + + + + Tailwind CSS Sidebar + +
:construction: Carousel:construction: Avatar:construction: Rating
+ + Tailwind CSS Carousel + + + + Tailwind CSS Avatar + + + + Tailwind CSS Rating + +
:construction: Input Field:construction: File Input:construction: Search Input
+ + Tailwind CSS Input Field + + + + Tailwind CSS File Input + + + + Tailwind CSS Search Input + +
:construction: Select:construction: Textarea:construction: Checkbox
+ + Tailwind CSS Select + + + + Tailwind CSS Textarea + + + + Tailwind CSS Checkbox + +
:construction: Radio:construction: Toggle:construction: Range Slider
+ + Tailwind CSS Radio + + + + Tailwind CSS Toggle + + + + Tailwind CSS Range Slider + +
:construction: Floating Label
+ + Tailwind CSS Floating Label + +
+ +## Community + +If you need help or just want to discuss about the library join the community on Github: + +⌨️ [Discuss about Flowbite on GitHub](https://github.com/themesberg/flowbite/discussions) + +For casual chatting with others using the library: + +💬 [Join the Flowbite Discord Server](https://discord.gg/4eeurUVvTy) + +## Contributing + +Thank you for your interest in helping! Visit our [guide on contributing](https://github.com/themesberg/flowbite-vue/blob/main/CONTRIBUTING.md) to get started. + +## Figma + +If you need the Figma files for the components you can check out our website for more information: + +🎨 [Get access to the Figma design files](https://flowbite.com/figma/) + +## Copyright and license + +The Flowbite name and logos are trademarks of Crafty Dwarf Inc. + +📝 [Read about the licensing terms](https://flowbite.com/getting-started/license/)