From 14c3fe34957acd9aae5dae15b1213552f9bf06e7 Mon Sep 17 00:00:00 2001
From: Riley Ho <riley@rileychh.dev>
Date: Mon, 16 Sep 2024 19:18:35 +0800
Subject: [PATCH] docs: add branded README

---
 .vscode/settings.json |  6 +++++
 README.md             | 59 +++++++++++--------------------------------
 2 files changed, 21 insertions(+), 44 deletions(-)

diff --git a/.vscode/settings.json b/.vscode/settings.json
index b55fbbf..3ee9c72 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -48,6 +48,12 @@
     "postcss"
   ],
 
+  // Markdownlint
+  "markdownlint.config": {
+    "first-line-h1": false,
+    "no-inline-html": false
+  },
+
   // Use the workspace version of TypeScript
   "typescript.tsdk": "node_modules/typescript/lib"
 }
diff --git a/README.md b/README.md
index f5db2a2..ee43a70 100644
--- a/README.md
+++ b/README.md
@@ -1,23 +1,26 @@
-# Nuxt 3 Minimal Starter
+<p align="center">
+  <img src="public/icon.svg" alt="NPC Logo" align="center" width="128" height="128">
+</p>
 
-Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
+<h1 align="center">Website</h1>
+
+<p align="center">The front page of NPC: Crafted with Nuxt, powered by passion</p>
+
+<p align="center">
+  <a href="https://ntut.club">
+    <img
+      alt="An NPC Project"
+      src="https://img.shields.io/badge/An_NPC_Project-black?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAzMiAzMiIgZmlsbD0iI2ZmZiI%2BPHBhdGggZD0iTTQgNHYyNGw4LTggMTYgOFY0bC04IDh6Ii8%2BPC9zdmc%2B"
+    >
+  </a>
+</p>
 
 ## Setup
 
 Make sure to install the dependencies:
 
 ```bash
-# npm
-npm install
-
-# pnpm
 pnpm install
-
-# yarn
-yarn install
-
-# bun
-bun install
 ```
 
 ## Development Server
@@ -25,17 +28,7 @@ bun install
 Start the development server on `http://localhost:3000`:
 
 ```bash
-# npm
-npm run dev
-
-# pnpm
 pnpm run dev
-
-# yarn
-yarn dev
-
-# bun
-bun run dev
 ```
 
 ## Production
@@ -43,33 +36,11 @@ bun run dev
 Build the application for production:
 
 ```bash
-# npm
-npm run build
-
-# pnpm
 pnpm run build
-
-# yarn
-yarn build
-
-# bun
-bun run build
 ```
 
 Locally preview production build:
 
 ```bash
-# npm
-npm run preview
-
-# pnpm
 pnpm run preview
-
-# yarn
-yarn preview
-
-# bun
-bun run preview
 ```
-
-Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.