From 9e212738c4fdfc7ed79211f5d85890e2d82a1301 Mon Sep 17 00:00:00 2001
From: Tom Donohue <monodot@gmail.com>
Date: Sat, 18 Jan 2025 13:20:41 +0000
Subject: [PATCH] more readme improvements

---
 README.md | 34 +++++++++++++++++++++-------------
 1 file changed, 21 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 2b4cb1c..3c8c83b 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,18 @@
-<div style="text-align: center">
+<div align="center">
     <h1>💅 manikure</h1>
-    <p><strong>Interactive Editor for Kubernetes resources</strong></p>
-    <p><strong>Design and validate your Kubernetes configurations without writing YAML</strong></p>
+    <p><strong>Interactive editor for Kubernetes resources</strong></p>
+    <p><strong>Design and validate your Kubernetes configurations... <em>without having to remember all of that YAML!</em></strong></p>
 </div>
 
 <hr/>
 
-<p style="text-align: center">
+<p align="center">
     <a href="https://manikure.netlify.app"><strong>👉 Try it out now: manikure.netlify.app 👈</strong></a>
 </p>
 
 <hr/>
 
-<div style="text-align: center">
+<div align="center">
     <img alt="GitHub License" src="https://img.shields.io/github/license/monodot/manikure">
 </div>
 
@@ -35,21 +35,29 @@
 - [ ] Support for creating Helm charts
 - [x] Make it look nicer (Now done using shadcn-vue!)
 
-## Project setup
+## Getting started
+
+### Use in your browser
+
+You can use Manikure in your browser without having to install it.
+
+Simply head to https://manikure.netlify.app.
+
+### Run locally
 
 If you want to build and run this application locally, you'll need _npm_ installed:
 
-```
+```shell
+# Install
 npm install
-```
-
-Compile and hot-reload for development (starts a web server and enables hot-reload):
 
-```
+# Compile and hot-reload for development (starts a web server and enables hot-reload):
 npm run dev
 ```
 
-Compile and minify for production (builds the application into the `dist/` folder):
+This will start a development server at `http://localhost:5173`.
+
+If you want to create a production build of the application (builds the application's HTML, CSS and JS into the `dist/` folder):
 
 ```
 npm run build
@@ -57,7 +65,7 @@ npm run build
 
 ## Licence
 
-(c) 2020-2024 Tom Donohue and authors. This is free software. It's provided to you under the terms of the [AGPL-3.0 License](LICENSE). You are free to copy, distribute or modify, but you must follow the terms of the licence.
+(c) 2020-2025 Tom Donohue and authors. This is free software. It's provided to you under the terms of the [AGPL-3.0 License](LICENSE). You are free to copy, distribute or modify, but you must follow the terms of the licence.
 
 ### What does this licence mean?