[Nuxt 3 - Pinia - Vuetify] Feat: Update README

starters/nuxt3-pinia-vuetify/README.md

@@ -1,42 +1,86 @@
-# Nuxt 3 Minimal Starter
+# nuxt3-pinia-vuetify starter kit
 
-Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
+This starter kit features **Nuxt.js 3**, **Pinia**, and **Vuetify**.
 
-## Setup
+## Table of Contents
 
-Make sure to install the dependencies:
+- [Overview](#overview)
+  - [Tech Stack](#tech-stack)
+  - [Included Tooling](#included-tooling)
+  - [Example Code](#example-code)
+- [Installation](#installation)
+  - [CLI (Recommended)](#cli-recommended)
+  - [Manual](#manual)
+- [Commands](#commands)
 
-```bash
-# yarn
-yarn install
+## Overview
 
-# npm
-npm install
+### Tech Stack
 
-# pnpm
-pnpm install
-```
+- [Nuxt.js v3.x](https://nuxt.com/)
+- [Vue v3.x](https://vuejs.org/)
+- [Pinia v2.x](https://pinia.vuejs.org/)
+- [Vuetify](https://vuetifyjs.com/)
+
+### Included Tooling
+
+- [Typescript](https://www.typescriptlang.org/) - Type checking
+- [ESLint](https://eslint.org/) - Code linting
+
+> **Note**: We didn't include Storybook in this starter kit because it is not yet compatible with Nuxt.js 3. We will add it back in when it is. Likewise we didn't include tests because the testing story for Nuxt.js 3 is still being worked out and it's not production ready.
+
+### Example Code
+
+In this `starters/nuxt3-pinia-vuetify` directory you will find the `CounterExample` and `FetchExample` directories in the components.
+
+The `CounterExample` directory component uses `Pinia` to control the state of the component. The directory contains the following files:
 
-## Development Server
+- CounterExample.vue
 
-Start the development server on http://localhost:3000
+The `FetchExample` directory component uses `useLazyFetch` to fetch data from the example `hello endpoint`. The directory contains the following files:
+
+- FetchExample.vue
+
+## Installation
+
+### CLI (Recommended)
 
 ```bash
-npm run dev
+npm create @this-dot/starter -- --kit nuxt3-pinia-vuetify
 ```
 
-## Production
-
-Build the application for production:
+or
 
 ```bash
-npm run build
+yarn create @this-dot/starter --kit nuxt3-pinia-vuetify
 ```
 
-Locally preview production build:
+- Follow the prompts to select the `nuxt3-pinia-vuetify` starter kit and name your new project.
+- `cd` into your project directory and run `yarn`.
+- Run `yarn dev` to start the development server.
+- Open your browser to `http://localhost:3000` to see the included example code running.
+
+### Manual
+
+This requires a download of the entire starter.dev repository and extraction of the `nuxt3-pinia-vuetify` kit from the starters directory.
 
 ```bash
-npm run preview
+git clone https://github.com/thisdot/starter.dev.git
 ```
 
-Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
+- Copy and rename the `starters/nuxt3-pinia-vuetify` directory to the name of your new project.
+- `cd` into your project directory and run `yarn`.
+- Run `yarn dev` to start the development server.
+- Open your browser to `http://localhost:3000` to see the included example code running.
+
+## Commands
+
+- `yarn dev` / `yarn start` - Starts the development server.
+- `yarn build` - Creates a `.output` directory with all your application, server and dependencies ready for production.
+- `yarn preview` - Starts a server to preview your Nuxt application after running the build command.
+- `yarn generate` - Pre-renders every route of your application and stores the result in plain HTML files that you can deploy on any static hosting services. The command triggers the `nuxi build` command with the `prerender` argument set to `true`
+- `yarn postinstall` - Creates a `.nuxt` directory in your application and generates types. This can be useful in a CI environment or as a `postinstall` command in your `package.json`.
+- `yarn lint:js` - Runs ESLint on the project.
+- `yarn lint:prettier` - Runs Prettier on the project.
+- `yarn lint` - Runs both `yarn lint:js` and `yarn lint:prettier`.
+- `yarn lint:fix` - Runs ESLint and Prettier on the project and fixes any errors.

starters/nuxt3-pinia-vuetify/package.json

@@ -19,7 +19,7 @@
 		"lint:js": "eslint --ext \".js,.ts,.vue\" --ignore-path .gitignore .",
 		"lint:prettier": "prettier --check .",
 		"lint": "run-s lint:js lint:prettier",
-		"lintfix": "prettier --write --list-different . && npm run lint:js --fix"
+		"lint:fix": "prettier --write --list-different . && npm run lint:js --fix"
 	},
 	"devDependencies": {
 		"@nuxtjs/eslint-config-typescript": "12.0.0",