mirror of
https://github.com/ArthurDanjou/ui.git
synced 2026-01-14 12:14:41 +01:00
chore(readme): improve
This commit is contained in:
35
README.md
35
README.md
@@ -1,6 +1,15 @@
|
|||||||
# @nuxthq/ui
|
# @nuxthq/ui
|
||||||
|
|
||||||
Components library as a Nuxt module using [TailwindCSS](https://tailwindcss.com) and [HeadlessUI](https://headlessui.com).
|
This module has been developed by the [NuxtLabs](https://nuxtlabs.com/) team for [Volta](https://volta.net) and [Nuxt Studio](https://nuxt.studio/), its goal is to provide everything related to UI when building a Nuxt app. This includes components, icons, colors, dark mode but also keyboard shortcuts.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Fully styled and customizable components
|
||||||
|
- HMR support through Nuxt App Config
|
||||||
|
- Dark mode support
|
||||||
|
- Keyboard shortcuts
|
||||||
|
- Bundled icons
|
||||||
|
- Fully typed
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
@@ -8,13 +17,11 @@ Components library as a Nuxt module using [TailwindCSS](https://tailwindcss.com)
|
|||||||
yarn add --dev @nuxthq/ui
|
yarn add --dev @nuxthq/ui
|
||||||
```
|
```
|
||||||
|
|
||||||
Then, register the module in your `nuxt.config.js`:
|
Then, register the module in your `nuxt.config.ts`:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { defineNuxtConfig } from 'nuxt'
|
|
||||||
|
|
||||||
export default defineNuxtConfig({
|
export default defineNuxtConfig({
|
||||||
buildModules: [
|
modules: [
|
||||||
'@nuxthq/ui'
|
'@nuxthq/ui'
|
||||||
]
|
]
|
||||||
})
|
})
|
||||||
@@ -29,3 +36,21 @@ If you want latest updates, please use `@nuxthq/ui-edge` in your `package.json`:
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
Visit http://ui.nuxtlabs.com to view the documentation.
|
||||||
|
|
||||||
|
## Credits
|
||||||
|
|
||||||
|
- [nuxt/nuxt](https://github.com/nuxt/nuxt)
|
||||||
|
- [nuxt-modules/color-mode](https://github.com/nuxt-modules/color-mode)
|
||||||
|
- [nuxt-modules/tailwindcss](https://github.com/nuxt-modules/tailwindcss)
|
||||||
|
- [tailwindlabs/tailwindcss](https://github.com/tailwindlabs/tailwindcss)
|
||||||
|
- [tailwindlabs/headlessui](https://github.com/tailwindlabs/headlessui)
|
||||||
|
- [vueuse/vueuse](https://github.com/vueuse/vueuse)
|
||||||
|
- [egoist/tailwindcss-icons](https://github.com/egoist/tailwindcss-icons)
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Licensed under the [MIT license](https://github.com/nuxtlabs/ui/blob/dev/LICENSE).
|
||||||
|
|||||||
Reference in New Issue
Block a user