mirror of
https://github.com/ArthurDanjou/ui.git
synced 2026-01-14 12:14:41 +01:00
docs: update readme
This commit is contained in:
committed by
Benjamin Canac
parent
98b3c3550c
commit
7dbfe4ecd6
19
README.md
19
README.md
@@ -1,3 +1,5 @@
|
||||
[](https://ui.nuxtlabs.com)
|
||||
|
||||
# Nuxt UI
|
||||
|
||||
[![npm version][npm-version-src]][npm-version-href]
|
||||
@@ -5,9 +7,9 @@
|
||||
[![License][license-src]][license-href]
|
||||
[![Nuxt][nuxt-src]][nuxt-href]
|
||||
|
||||
This module has been developed by [NuxtLabs](https://nuxtlabs.com/) for [Volta](https://volta.net) and [Nuxt Studio](https://nuxt.studio/). It provides everything related to UI when building a Nuxt application, including components, icons, colors, dark mode and also keyboard shortcuts.
|
||||
Nuxt UI provides everything related to UI when building Nuxt applications: components, icons, colors, dark mode and also keyboard shortcuts.
|
||||
|
||||
[](https://ui.nuxtlabs.com)
|
||||
Is has been developed by [NuxtLabs](https://nuxtlabs.com/) for [Volta](https://volta.net), [Nuxt Studio](https://nuxt.studio/) and the Nuxt community.
|
||||
|
||||
## Features
|
||||
|
||||
@@ -19,10 +21,19 @@ This module has been developed by [NuxtLabs](https://nuxtlabs.com/) for [Volta](
|
||||
- Bundled icons
|
||||
- Fully typed
|
||||
|
||||
Read more on [ui.nuxtlabs.com](https://ui.nuxtlabs.com)
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
yarn add --dev @nuxthq/ui
|
||||
# Using npm
|
||||
npm install @nuxthq/ui
|
||||
|
||||
# Using yarn
|
||||
yarn add @nuxthq/ui
|
||||
|
||||
# Using pnpm
|
||||
pnpm add @nuxthq/ui
|
||||
```
|
||||
|
||||
Then, register the module in your `nuxt.config.ts`:
|
||||
@@ -47,7 +58,7 @@ If you want latest updates, please use `@nuxthq/ui-edge` in your `package.json`:
|
||||
|
||||
## Documentation
|
||||
|
||||
Visit https://ui.nuxtlabs.com to view the documentation.
|
||||
Visit https://ui.nuxtlabs.com to explore the documentation.
|
||||
|
||||
## Credits
|
||||
|
||||
|
||||
Reference in New Issue
Block a user