From a444adae43fd647ced9e4243fb2a7654b56d9552 Mon Sep 17 00:00:00 2001
From: Rick <1450685+LinuxSuRen@users.noreply.github.com>
Date: Sat, 27 Nov 2021 22:21:34 +0800
Subject: [PATCH] Chore: add a simple contribution guide (#85)

---
 CONTRIBUTION.md | 15 +++++++++++++++
 README.md       |  2 ++
 2 files changed, 17 insertions(+)
 create mode 100644 CONTRIBUTION.md

diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md
new file mode 100644
index 0000000..2973e05
--- /dev/null
+++ b/CONTRIBUTION.md
@@ -0,0 +1,15 @@
+Welcome to join us. Please read the following instructions to setup your local development environment.
+
+First, install `pnpm` according to [the official document](https://pnpm.io/installation).
+
+then, install some necessary depdencies:
+
+```shell
+pnpm install
+```
+
+you can run it once you have finished it.
+
+```shell
+pnpm start
+```
diff --git a/README.md b/README.md
index 311a770..1154f7c 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,8 @@ See [Projects](https://github.com/Dreamacro/clash-dashboard/projects)
 
 ### Start develop with ClashX(Dev Mode)
 
+You can setup your local development environment with [the contribution guide](CONTRIBUTION.md).
+
 ```bash
 # Enable ClashX with Dev Mode
 defaults write com.west2online.ClashX kEnableDashboard -bool YES