Skip to content

Commit 9ee1b6e

Browse files
committed
Cleanup README
1 parent 8100191 commit 9ee1b6e

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed
Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
# `@hkamran/vite-scaffold-vue-ts`
2-
[![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL3.0-green.svg)](../../LICENSE.md) [![npm version](https://badge.fury.io/js/%40hkamran%2Fvite-scaffold-vue-ts.svg)](https://badge.fury.io/js/%40hkamran%2Fvite-scaffold-vue-ts.svg)
2+
3+
[![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL3.0-green.svg)](../../LICENSE.md)
4+
[![npm version](https://badge.fury.io/js/%40hkamran%2Fvite-scaffold-vue-ts.svg)](https://badge.fury.io/js/%40hkamran%2Fvite-scaffold-vue-ts.svg)
35

46
A scaffolding system for Vite-powered Vue 3 (TypeScript) apps
57

6-
## Installation
7-
```bash
8-
$ npm i -D @hkamran/vite-scaffold-vue-ts
9-
```
8+
## Usage
109

1110
```bash
12-
$ npx @hkamran/vite-scaffold-vue-ts
11+
npx @hkamran/vite-scaffold-vue-ts
1312
```
1413

15-
## Usage
16-
I recommend using this program with `npx`, via `npx @hkamran/vite-scaffold-vue-ts`. However if you would like, you can also use it by installing it, then using the `vite-scaffold-vue-ts` binary.
17-
1814
### Flags
19-
- `--npm-executable [npm executable]` (optional, defaults to `npm`): The NPM executable to use
20-
- `--styling`: Install [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/) and configure them
21-
- `--vite-html`: Install [`vite-plugin-html-config`](https://github.com/ahwgs/vite-plugin-html-config) to manage HTML head tags and configure it
22-
- `--router`: Install [`vue-router`](https://router.vuejs.org/) and configure it
23-
- `--tailwindcss`: Install [Tailwind CSS](https://tailwindcss.com/) and configure it
15+
16+
- `--npm-executable [npm executable]` (optional, defaults to `npm`): The `npm` executable
17+
to use (e.g. `npm`, [`pnpm`](https://pnpm.io), or [`yarn`](https://yarnpkg.com))
18+
- `--styling`: Install and configure [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/)
19+
- `--vite-html`: Install and configure [`vite-plugin-html-config`](https://github.com/ahwgs/vite-plugin-html-config)
20+
to manage HTML head tags
21+
- `--router`: Install and configure [`vue-router`](https://router.vuejs.org/)
22+
- `--tailwindcss`: Install and configure [Tailwind CSS](https://tailwindcss.com/)
2423
- `--netlify`: Add the Netlify [`_redirects` file](https://docs.netlify.com/routing/redirects/)
25-
- `--disallow-robots`: Add a `robots.txt` that disallows all bots (omitting this flag will add the version that allows all)
24+
- `--disallow-robots`: Add a `robots.txt` that disallows all bots (omitting this
25+
flag will add the version that allows all)
2626
- `--verbose`: Show output

0 commit comments

Comments
 (0)