From e29af4e63893b1ac51ad7b3a122019ec4ccac013 Mon Sep 17 00:00:00 2001
From: Helen Chong <119173961+helenclx@users.noreply.github.com>
Date: Sat, 27 Apr 2024 15:36:01 +0800
Subject: [PATCH] Add information about dependencies and self-hosted assets

---
 README.md | 35 +++++++++++++++++++++++++++--------
 1 file changed, 27 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 4b7e9c33..61bb7bca 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,34 @@
-# neocities-leilukin
+# Leilukin's Hub
 
-To install dependencies:
+Source code of my personal and hobby website, [Leilukin's Hub](https://leilukin.neocities.org/), hosted on [Neocities](https://neocities.org/).
 
-```bash
+## Dependencies
+- [Eleventy](https://www.11ty.dev/)
+- Eleventy's official [RSS](https://www.11ty.dev/docs/plugins/rss/) plugin
+- Eleventy's official [Navigation](https://www.11ty.dev/docs/plugins/navigation/) plugin
+- [Emoji Read Time Eleventy Plugin](https://11ty.rocks/#plugin-emoji-read-time)
+- [eleventy-plugin-metagen](https://www.npmjs.com/package/eleventy-plugin-metagen)
+- [eleventy-plugin-embed-everything](https://www.npmjs.com/package/eleventy-plugin-embed-everything)
+- [markdown-it-anchor](https://www.npmjs.com/package/markdown-it-anchor)
+- [Table of Contents (nesting) Eleventy Plugin](https://www.npmjs.com/package/eleventy-plugin-nesting-toc)
+
+## Self-hosted Assets
+- [Noto Sans](https://fonts.google.com/noto/specimen/Noto%20Sans) font family
+- [Font Awesome](https://fontawesome.com/)
+
+## Run Locally
+1. Clone this repository locally
+```
+git clone https://github.com/helenclx/Neocities-Leilukin.git
+```
+2. Install dependencies
+```
 bun install
 ```
-
-To run:
-
-```bash
-bun run index.ts
+3. Run the project
 ```
+bun run start
+```
+4. Open http://localhost:8080/ in your browser
 
 This project was created using `bun init` in bun v1.1.0. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.