From a5362228f336341f5df8419b43a3e4dad93e33aa Mon Sep 17 00:00:00 2001
From: Clas Wen <clas.wen@icloud.com>
Date: Thu, 3 Apr 2025 19:54:01 +0800
Subject: [PATCH] update readme

---
 README.md | 34 +++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9e7f780..e53c933 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,35 @@
 # documents
 
-协会文档
+Documents for nbtca.
+
+## How to use
+
+### Install dependencies
+
+1. Install Node.js
+2. Install pnpm
+   ```bash
+   npm install -g pnpm
+   ```
+3. Install dependencies
+   ```bash
+    pnpm install
+   ```
+
+### Start development server
+
+```bash
+pnpm docs:dev
+```
+
+### Build for production
+
+```bash
+pnpm docs:build
+```
+
+### Lint code
+
+```bash
+pnpm lint
+```