From 2de09279b63096a9379523fab69860194fc79ed3 Mon Sep 17 00:00:00 2001 From: Alexandre Date: Sun, 12 Jul 2020 13:31:16 +0200 Subject: [PATCH] :pencil: Improve README --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 93b6ca5..324d16b 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,11 @@ A simple integration to run [solid-js](https://github.com/ryansolid/solid) with # Quickstart ```bash -npx degit amoutonbrady/vite-plugin-solid/playground my-solid-project -cd my-solid-project -npm install -npm run dev # starts dev-server with hot-module-reloading -npm run build # builds to /dist +$ npx degit amoutonbrady/vite-plugin-solid/playground my-solid-project +$ cd my-solid-project +$ npm install +$ npm run dev # starts dev-server with hot-module-reloading +$ npm run build # builds to /dist ``` # Usage @@ -27,9 +27,12 @@ npm run build # builds to /dist Install vite and vite-plugin-solid as dev dependencies ```bash -$ npm install -D vite @amoutonbrady/vite-plugin-solid # with npm -$ pnpm add -D vite @amoutonbrady/vite-plugin-solid # with pnpm -$ yarn add -D vite @amoutonbrady/vite-plugin-solid # with yarn +# with npm +$ npm install -D vite @amoutonbrady/vite-plugin-solid +# with pnpm +$ pnpm add -D vite @amoutonbrady/vite-plugin-solid +# with yarn +$ yarn add -D vite @amoutonbrady/vite-plugin-solid ``` Add it as plugin to `vite.config.ts` @@ -98,12 +101,10 @@ Just use regular `vite` or `vite build` commands ```json { - ..., "scripts": { "dev": "vite", "build": "vite build" } - ..., } ```