From 591536b29c551b9fc6ab15aee386805c0262b8e7 Mon Sep 17 00:00:00 2001
From: trafficlunar <trafficlunar@proton.me>
Date: Sat, 4 Jan 2025 23:16:26 +0000
Subject: [PATCH] docs: update README.md

---
 README.md | 30 +++++++++++++++++++++++++-----
 1 file changed, 25 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 0e79e17..1541ad0 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,27 @@
 <p align="center">
-    <img src="src/assets/blockmatic-colored.svg" width="400" title="blockmatic">
-    <h3 align="center">An online image to Minecraft schematic converter with an editor</h3>
-
-    todo: add links, development instructions
-
+    <a href="https://blockmatic.trafficlunar.net"><img src="src/assets/blockmatic-colored.svg" width="400" title="blockmatic"></a>
+    <br>
+    <h3 align="center">Online pixel art editor for Minecraft (with support for images!)</h3>
+    <h3 align="center"><a href="https://blockmatic.trafficlunar.net"><img src="https://github.com/intergrav/devins-badges/blob/v3/assets/cozy/documentation/website_64h.png" title="Visit the website"></a></h3>
 </p>
+
+## Development Instructions
+
+Blockmatic uses React, Vite, pnpm, and TypeScript. To get started in development mode, run:
+
+```bash
+$ pnpm run dev
+```
+
+This will start the development server and send a link in console to Blockmatic.
+
+To build and preview blockmatic for production, run:
+
+```bash
+$ pnpm run build
+$ pnpm run preview
+```
+
+The first command builds the application, and the second one previews it locally.
+
+To somewhat automatically generate data for blockmatic, please refer to the [README.md](generator/README.md) in the `generator` folder.