From ea394e46932b52d7f857d4f58957a182bc1b1b48 Mon Sep 17 00:00:00 2001
From: Lunny Xiao <xiaolunwen@gmail.com>
Date: Mon, 17 Mar 2025 21:13:45 -0700
Subject: [PATCH] Improve the README

---
 README.md | 51 ++++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 44 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index cec70dc..440cd8a 100644
--- a/README.md
+++ b/README.md
@@ -1,23 +1,60 @@
 # Gitea MCP Server
 
-## Usage
+**Gitea MCP Server** is an integration plugin designed to connect Gitea with Multi-Command Protocol (MCP) systems. This allows for seamless command execution and repository management through an MCP-compatible chat interface.
+
+## 🚧 Installation
+
+There is currently no official release. You will need to build the Gitea MCP Server from source.
+
+### 🔧 Build from Source
+
+Before building, make sure you have the following installed:
+	- make
+	- Golang (Go 1.24 or later recommended)
+
+Clone the repository and run:
+
+```bash
+make build
+```
+
+### 🛠️ Add to PATH
+
+After building, copy the binary gitea-mcp to a directory included in your system’s PATH. For example:
+
+```bash
+cp gitea-mcp /usr/local/bin/
+```
+
+## 🚀 Usage
+
+To configure the MCP server for Gitea, add the following to your MCP configuration file:
 
-**MCP Server Config**
 ```json
 {
   "mcpServers": {
     "gitea": {
       "command": "gitea-mcp",
       "args": [
-        "-t": "stdio",
-        "--host": "https://gitea.com"//,
-       // "--token": "<your personal access token>"
+        "-t", "stdio",
+        "--host", "https://gitea.com"
+        // "--token", "<your personal access token>"
       ],
       "env": {
-      //   "GITEA_HOST": "https://gitea.com",
-         "GITEA_ACCESS_TOKEN": "<your personal access token>"
+        // "GITEA_HOST": "https://gitea.com",
+        "GITEA_ACCESS_TOKEN": "<your personal access token>"
       }
     }
   }
 }
 ```
+> [!NOTE]
+> You can provide your Gitea host and access token either as command-line arguments or environment variables.
+
+Once everything is set up, try typing the following in your MCP-compatible chatbox:
+
+```
+list all my repositories
+```
+
+Enjoy exploring and managing your Gitea repositories via chat!
\ No newline at end of file