From 7a6cd14ee591a1fb90897fa7fedcbb19a1002900 Mon Sep 17 00:00:00 2001
From: Milan <mricoul@beapi.fr>
Date: Wed, 8 Dec 2021 01:18:25 +0100
Subject: [PATCH] docs (README) : complete README

---
 README.md | 27 ++++++++++++++++++++++-----
 1 file changed, 22 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 69bcd0b..26d019a 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,12 @@
-# Vite WordPress
+# Vite ⚡️ WordPress
 
 Vite WordPress is a simple and quick WordPress starter theme using the fastest build tool: [Vite](https://vitejs.dev/).
 
-## Get started
+## Get started 🚀
 
 ### Set WP_ENV constant
 
-In your `wp-config.php` file, you have define a `WP_ENV` constant according to your environment so that Vite WordPress can determine which assets need to be loaded.
+In your `wp-config.php` file, you have to define a `WP_ENV` constant according to your environment so that Vite WordPress can determine which assets need to be loaded.
 In case you are in development mode, set the constant to `development`.
 
 ```php
@@ -29,6 +29,23 @@ $ yarn
 $ npm install
 ```
 
-## [Change logs](CHANGELOG.md)
+### Development 🛠
+
+Run your local backend server, then in your theme run :
+```bash
+$ yarn dev
+```
+
+### Build 📦
+
+```bash
+$ yarn build
+```
+
+## Known issues 🪲
 
-## Readme coming soon...
\ No newline at end of file
+### HTTPS
+
+The theme currently doesn't work in dev environment with a https server. There is an infinite HMR reloading loop.
+
+## [Change logs](CHANGELOG.md)