Merge pull request #73 from binhtran432k/docs/readme

docs(readme): update details

Author: binhtddev

README.md

@@ -1,28 +1,79 @@
-# binhtran432k.github.io
+# My Personal Portfolio
 
-To install dependencies:
+Welcome to the repository for my **Personal Portfolio**! This project serves as
+my personal website, showcasing my work, skills, and background. It’s a
+minimalist, self-built solution designed to focus on efficiency, performance,
+and creativity.
 
-```bash
-bun install
-```
+## Features
 
-To build the website:
+### Built with Simplicity and Efficiency
 
-```bash
-bun run build
-```
+- **Internal Static Site Generator (SSG):** Custom-built on top of **[Van
+  JS](https://vanjs.org/)** to minimize dependencies and build tools.
+- **[Bun](https://bun.sh/):** Used to minify JavaScript and CSS for faster load
+  times and to run the local development server efficiently.
 
-To build the website in watch mode (use with preview):
+### Styling and Effects
 
-```bash
-bun build:watch
-```
+- **Pure CSS:** No frameworks—just clean, handcrafted styles for optimal
+  performance and aesthetics.
+- **WebGL:** Used for fancy 2D image effects with shaders, creating dynamic and
+  visually appealing motion without third-party plugins or libraries.
 
-To preview the website:
+### Seamless Deployment
 
-```bash
-bun preview
-```
+- **GitHub Actions:** Automated CI/CD pipeline to build and deploy the
+  portfolio to GitHub Pages, ensuring every update goes live effortlessly.
 
-This project was created using `bun init` in bun v1.1.31. [Bun](https://bun.sh)
-is a fast all-in-one JavaScript runtime.
+### Pages
+
+- **Homepage (`/`):** Introduces me, my work, and my interests in a simple yet
+  elegant layout [[link](https://binhtran432k.com)].
+- **Resume Page (`/resume`):** Dedicated page to showcase my detailed resume
+  [[link](https://binhtran432k.com/resume)].
+
+## Why Build This?
+
+This project is a reflection of my skills and philosophy as a developer. By
+using self-built tools and minimal third-party dependencies, I aim to create a
+site that is:
+
+- Lightweight and fast.
+- Easy to maintain.
+- Fully customized to represent my personal style.
+
+## Getting Started
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/binhtran432k/binhtran432k.github.io.git
+   ```
+
+1. Run the development server or just build it:
+
+   ```bash
+   # for development
+   bun run preview
+   # for build only
+   bun run build
+   ```
+
+## What's Inside?
+
+This repository contains:
+
+- **Custom SSG** for building the portfolio.
+- **CSS styles** for the entire site.
+- **WebGL effects** for fancy 2D image effects.
+- **Resume page** with detailed information about my professional background.
+
+## Contributing
+
+While this is a personal project, feel free to explore the code and offer
+suggestions by opening an issue or a pull request.
+
+---
+
+Thank you for visiting my portfolio repository! 🚀