Skip to content

Commit 03110d8

Browse files
committed
docs: base README
1 parent 23df9a5 commit 03110d8

File tree

1 file changed

+3
-78
lines changed

1 file changed

+3
-78
lines changed

README.md

+3-78
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,5 @@
1-
<p align="center">
2-
<img src="https://user-images.githubusercontent.com/11247099/140462375-7b7ac4db-35b7-453c-8a05-13d8d20282c4.png" width="600"/>
3-
</p>
1+
# Qrs
42

5-
<h2 align="center">
6-
<a href="https://github.com/antfu/vitesse">Vitesse</a> for Nuxt 3
7-
</h2><br>
3+
Stream data through multiple QRCodes
84

9-
<p align="center">
10-
<br>
11-
<a href="https://vitesse-nuxt3.netlify.app/">🖥 Online Preview</a>
12-
<br><br>
13-
<a href="https://stackblitz.com/github/antfu/vitesse-nuxt"><img src="https://developer.stackblitz.com/img/open_in_stackblitz.svg" alt=""></a>
14-
</p>
15-
16-
## Features
17-
18-
- 💚 [Nuxt 3](https://nuxt.com/) - SSR, ESR, File-based routing, components auto importing, modules, etc.
19-
20-
- ⚡️ Vite - Instant HMR.
21-
22-
- 🎨 [UnoCSS](https://github.com/unocss/unocss) - The instant on-demand atomic CSS engine.
23-
24-
- 😃 Use icons from any icon sets in Pure CSS, powered by [UnoCSS](https://github.com/unocss/unocss).
25-
26-
- 🔥 The `<script setup>` syntax.
27-
28-
- 🍍 [State Management via Pinia](https://github.com/vuejs/pinia), see [./app/composables/user.ts](./app/composables/user.ts).
29-
30-
- 📑 [Layout system](./app/layouts).
31-
32-
- 📥 APIs auto importing - for Composition API, VueUse and custom composables.
33-
34-
- 🏎 Zero-config cloud functions and deploy.
35-
36-
- 🦾 TypeScript, of course.
37-
38-
- 📲 [PWA](https://github.com/vite-pwa/nuxt) with offline support and auto-update behavior.
39-
40-
## Plugins
41-
42-
### Nuxt Modules
43-
44-
- [VueUse](https://github.com/vueuse/vueuse) - collection of useful composition APIs.
45-
- [ColorMode](https://github.com/nuxt-modules/color-mode) - dark and Light mode with auto detection made easy with Nuxt.
46-
- [UnoCSS](https://github.com/unocss/unocss) - the instant on-demand atomic CSS engine.
47-
- [Pinia](https://github.com/vuejs/pinia) - intuitive, type safe, light and flexible Store for Vue.
48-
- [VitePWA](https://github.com/vite-pwa/nuxt) - zero-config PWA Plugin for Nuxt 3.
49-
- [DevTools](https://github.com/nuxt/devtools) - unleash Nuxt Developer Experience.
50-
51-
## IDE
52-
53-
We recommend using [VS Code](https://code.visualstudio.com/) with [Volar](https://github.com/johnsoncodehk/volar) to get the best experience (You might want to disable [Vetur](https://vuejs.github.io/vetur/) if you have it).
54-
55-
## Variations
56-
57-
- [vitesse](https://github.com/antfu/vitesse) - Opinionated Vite Starter Template
58-
- [vitesse-lite](https://github.com/antfu/vitesse-lite) - Lightweight version of Vitesse
59-
- [vitesse-nuxt-bridge](https://github.com/antfu/vitesse-nuxt-bridge) - Vitesse for Nuxt 2 with Bridge
60-
- [vitesse-webext](https://github.com/antfu/vitesse-webext) - WebExtension Vite starter template
61-
62-
## Try it now!
63-
64-
### Online
65-
66-
<a href="https://stackblitz.com/github/antfu/vitesse-nuxt"><img src="https://developer.stackblitz.com/img/open_in_stackblitz.svg" alt=""></a>
67-
68-
### GitHub Template
69-
70-
[Create a repo from this template on GitHub](https://github.com/antfu/vitesse-nuxt/generate).
71-
72-
### Clone to local
73-
74-
If you prefer to do it manually with the cleaner git history
75-
76-
```bash
77-
npx degit antfu/vitesse-nuxt my-nuxt-app
78-
cd my-nuxt-app
79-
pnpm i # If you don't have pnpm installed, run: npm install -g pnpm
80-
```
5+
<video src="https://assets-storage.guii.ai/qrs-demo.mp4" width="290px" loop />

0 commit comments

Comments
 (0)