Skip to content

Commit

Permalink
chore: add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pi0 committed Jan 17, 2022
0 parents commit 36a9a15
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
*.lock*
*.log*
.nuxt
.output
node_modules
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 - Nuxt Project

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# 🪄 Nuxt Starter Templates

> Quickly get started with a minimal Nuxt starter template!
## Usage

You can use `nuxi` CLI to clone latest template to an empty directory:

```sh
$ npx nuxi init [-t,--template=<template>] [<dir>]
```

**Example:** Clone `v3` to `my-app` directory:

```sh
$ npx nuxi init -t v3 nuxt-app
```

## Templates

Name | Description | Use
-----|-------------|---------
[v3](https://github.com/nuxt/starter/tree/v3) | Minimal Nuxt 3 | `npx nuxi init -t nuxt/starter#v3`
[v3-codesandbox](https://github.com/nuxt/starter/tree/v3-codesandbox) | Nuxt 3 + Codesandbox | [CodeSandbox](https://codesandbox.io/s/github/nuxt/starter/tree/v3-codesandbox)
[v3-stackblitz](https://github.com/nuxt/starter/tree/v3-stackblitz) | Nuxt 3 + Stackblitz | [Stackblitz](https://stackblitz.com/github/nuxt/starter/tree/v3-stackblitz)
[v3-vercel](https://github.com/nuxt/starter/tree/v3-vercel) | Nuxt 3 + Vercel | [Vercel](https://vercel.com/new/clone?repository-url=https://github.com/nuxt/starter/tree/v3-vercel&demo-title=Nuxt%203%20Public%20Beta&demo-description=Deploy%20a%20simple%20Nuxt%203%20application%20to%20get%20started.&demo-url=https://nuxt-3.examples.vercel.com&demo-image=https://nuxt-3.examples.vercel.com/screenshot.jpg)
[v2-bridge](https://github.com/nuxt/starter/tree/v2-bridge) | Nuxt 2 + Bridge | `npx nuxi init -t nuxt/starter#v2-bridge`
[v2-bridge-codesandbox](https://github.com/nuxt/starter/tree/v2-bridge-codesandbox) | Nuxt 2 + Bridge + Codesandbox | [CodeSandbox](https://codesandbox.io/s/github/nuxt/starter/tree/v2-bridge-codesandbox)
[v2](https://github.com/nuxt/starter/tree/v2) | Nuxt 2 starter | `npx nuxi init -t nuxt/starter#v2`
[v2-stackblitz](https://github.com/nuxt/starter/tree/v2-stackblitz) | Nuxt 2 + Stackblitz | [Stackblitz](https://stackblitz.com/github/nuxt/starter/tree/v2-stackblitz)

## Contribution

Each template is maintained in a branch (see [all branches](https://github.com/nuxt/starter/branches)).
For improvements, please open a Pull Request to each individual branch.

## License

[MIT](./LICENSE) - Made with 💚

0 comments on commit 36a9a15

Please sign in to comment.