From b184c57a2faf231ac3dc4eac5837660f8e41c38f Mon Sep 17 00:00:00 2001
From: Wout <hi@wout.codes>
Date: Thu, 17 Aug 2023 09:42:42 +0200
Subject: [PATCH] docs: update documentation for script/setup

---
 README.md | 12 +++++-------
 1 file changed, 5 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 2311220..266efbd 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,8 @@
 
   <br>
 
-  Lucky Vite
+Lucky Vite
+
 </h1>
 
 <h3 align="center">
@@ -97,6 +98,7 @@ Change the scripts section in `package.json` to use vite instead of laravel mix:
 ### Further steps
 
 - if you use the CI workflow for Github Actions, you need to change `yarn prod` into `yarn build` in `ci.yml`
+- if you use `script/setup`, uncomment `yarn dev | indent` under `Compiling assets`
 - you may want to exclude Vite's `outDir` (e.g. `public/assets`) from the repo
 - all the `laravel-mix` dependencies can be removed from from `package.json`
 - `webpack.mix.js` can be removed
@@ -187,12 +189,7 @@ Lucky and Vite share some information which is managed through the `config/lucky
 
 ```json
 {
-  "aliases": [
-    "css",
-    "fonts",
-    "images",
-    "js"
-  ],
+  "aliases": ["css", "fonts", "images", "js"],
   "outDir": "public/assets",
   "root": "src/js",
   "entry": "entry",
@@ -238,6 +235,7 @@ $ guardian
 ```
 
 This will automatically:
+
 - run ameba for src and spec files
 - run the relevant spec for any file in src
 - run spec file whenever they are saved