From 9604097e7f6f37f25878ce629b56ffe74684ad6c Mon Sep 17 00:00:00 2001
From: Riyyi <riyyi3@gmail.com>
Date: Sun, 24 Nov 2024 12:00:48 +0100
Subject: [PATCH] Meta: Add usage section to the README

---
 README.org   | 58 ++++++++++++++++++++++++++++++++++++++++++++--------
 package.json |  3 ++-
 2 files changed, 52 insertions(+), 9 deletions(-)

diff --git a/README.org b/README.org
index 5741699..08318e1 100644
--- a/README.org
+++ b/README.org
@@ -2,25 +2,64 @@
 
 Website, written in Typescript.
 
+* Usage
+
+** Setup
+
+Install dependencies:
+
+#+BEGIN_SRC sh
+$ bun install
+#+END_SRC
+
+** Development Server
+
+Start the development server on =http://localhost:3000=:
+
+#+BEGIN_SRC sh
+$ bun run dev
+$ bun run dev -o  # automatically open in the browser
+#+END_SRC
+
+** Production
+
+Build for production:
+
+#+BEGIN_SRC sh
+$ bun nuxi build     # for server-side rendering or hybrid
+$ bun nuxi generate  # for static site generation
+#+END_SRC
+
+Locally preview production build:
+
+#+BEGIN_SRC sh
+$ bun run preview  # requires building first!
+#+END_SRC
+
+Reference: [[https://nuxt.com/docs/getting-started/deployment#client-side-only-rendering][nuxt/docs/deployment#client-side-only-rendering]]
+
 * Libraries
 
-- Vue.js 3
-- Nuxt
-- Pinia
-- PrimeVue
-- ESLint
+- [[https://github.com/vuejs/core][Vue3]] JavaScript framework
+- [[https://github.com/nuxt/nuxt][Nuxt]] Vue framework
+- [[https://github.com/vuejs/pinia][Pinia]] State management
+- [[https://github.com/primefaces/primevue][PrimeVue]] Vue component library
+- [[https://github.com/colinhacks/zod][Zod]] Schema validation
+- [[https://github.com/microsoft/TypeScript][Typescript]] Static types in JavaScript
+- [[https://github.com/eslint/eslint][ESLint]] Code analyses tool
 
-* Development
+** Package Reproduction
 
-The following editor setup has been used:
+The following bun commands have been run to fill the =package.json=:
 
 #+BEGIN_SRC sh
 $ bun x nuxi@latest init website
+
+# Development
 $ bun nuxi module add eslint
 $ bun install --dev typescript
 $ bun install --dev @vue/language-server
 $ bun install --dev @vue/typescript-plugin
-
 $ bun install -g typescript
 $ bun install -g @vue/language-server
 $ bun install -g @vue/typescript-plugin
@@ -31,4 +70,7 @@ $ bun install pinia
 # PrimeVue
 $ bun install primevue primeicons @primevue/themes
 $ bun install --dev @primevue/nuxt-module
+
+# Zod
+$ bun install zod
 #+END_SRC
diff --git a/package.json b/package.json
index b3ebb40..da7ae93 100644
--- a/package.json
+++ b/package.json
@@ -16,7 +16,8 @@
 		"primeicons": "^7.0.0",
 		"primevue": "^4.2.3",
 		"vue": "latest",
-		"vue-router": "latest"
+		"vue-router": "latest",
+		"zod": "^3.23.8"
 	},
 	"devDependencies": {
 		"@nuxt/eslint": "^0.7.1",