diff --git a/.all-contributorsrc b/.all-contributorsrc
new file mode 100644
index 0000000..eba9b98
--- /dev/null
+++ b/.all-contributorsrc
@@ -0,0 +1,59 @@
+{
+ "projectName": "clash-dashboard",
+ "projectOwner": "Dreamacro",
+ "files": [
+ "README.md"
+ ],
+ "imageSize": 100,
+ "commit": false,
+ "contributors": [
+ {
+ "login": "jas0ncn",
+ "name": "Jason Chen",
+ "avatar_url": "https://avatars2.githubusercontent.com/u/3380894?v=4",
+ "profile": "https://ijason.cc",
+ "contributions": [
+ "design",
+ "code",
+ "bug",
+ "ideas",
+ "review"
+ ]
+ },
+ {
+ "login": "Dreamacro",
+ "name": "Dreamacro",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/8615343?v=4",
+ "profile": "https://github.com/Dreamacro",
+ "contributions": [
+ "code",
+ "bug",
+ "ideas",
+ "review",
+ "platform"
+ ]
+ },
+ {
+ "login": "chs97",
+ "name": "chs97",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/12679581?v=4",
+ "profile": "http://www.hs97.cn",
+ "contributions": [
+ "code",
+ "bug",
+ "review"
+ ]
+ },
+ {
+ "login": "yichengchen",
+ "name": "Yicheng",
+ "avatar_url": "https://avatars3.githubusercontent.com/u/11733500?v=4",
+ "profile": "https://github.com/yichengchen",
+ "contributions": [
+ "ideas",
+ "platform"
+ ]
+ }
+ ],
+ "repoType": "github"
+}
diff --git a/README.md b/README.md
index aeb67fc..8d6ac67 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,70 @@
-# clash-dashboard
+
+
+
+ Clash Dashboard
+
+
-web port of clash
+Web Dashboard for Clash, now host on ClashX(Dev Mode)
+
+
+
+
+
+
+
+## Features
+
+- All ClashX configurations
+- Add, modify or remove Proxies
+- Add, modify or remove Proxy Groups
+- Add, modify or remove Rules
+- Real time Log
+
+## Progress
+
+See [Projects](https://github.com/Dreamacro/clash-dashboard/projects)
+
+## Discussion
+
+[Telegram Group](https://t.me/clash_discuss)
+
+## Developing
+
+**NOTE: Dashboard now only support ClashX environment**
+
+### Start develop with ClashX(Dev Mode)
+
+```bash
+# Enable ClashX with Dev Mode
+defaults write com.west2online.ClashX kEnableDashboard -bool YES
+
+# Set dashboard entry
+defaults write com.west2online.ClashX webviewUrl "http://localhost:8080/"
+```
+
+### Development Env
+
+This command will start Clash Dashboard at `http://localhost:8080/`
+
+```bash
+npm start
+```
+
+### Build for production
+
+```bash
+npm run build
+```
+
+## Contributors
+
+
+
+| [
Jason Chen](https://ijason.cc)
[🎨](#design-jas0ncn "Design") [💻](https://github.com/Dreamacro/clash-dashboard/commits?author=jas0ncn "Code") [🐛](https://github.com/Dreamacro/clash-dashboard/issues?q=author%3Ajas0ncn "Bug reports") [🤔](#ideas-jas0ncn "Ideas, Planning, & Feedback") [👀](#review-jas0ncn "Reviewed Pull Requests") [🌍](#translation-jas0ncn "Translation") | [
Dreamacro](https://github.com/Dreamacro)
[💻](https://github.com/Dreamacro/clash-dashboard/commits?author=Dreamacro "Code") [🐛](https://github.com/Dreamacro/clash-dashboard/issues?q=author%3ADreamacro "Bug reports") [🤔](#ideas-Dreamacro "Ideas, Planning, & Feedback") [👀](#review-Dreamacro "Reviewed Pull Requests") [🌍](#translation-Dreamacro "Translation") [📦](#platform-Dreamacro "Packaging/porting to new platform") | [
chs97](http://www.hs97.cn)
[💻](https://github.com/Dreamacro/clash-dashboard/commits?author=chs97 "Code") [🐛](https://github.com/Dreamacro/clash-dashboard/issues?q=author%3Achs97 "Bug reports") [👀](#review-chs97 "Reviewed Pull Requests") | [
Yicheng](https://github.com/yichengchen)
[🤔](#ideas-yichengchen "Ideas, Planning, & Feedback") [📦](#platform-yichengchen "Packaging/porting to new platform") |
+| :---: | :---: | :---: | :---: |
+
+
+## LICENSE
+
+MIT License
diff --git a/package.json b/package.json
index f5eb8aa..21a2b2c 100644
--- a/package.json
+++ b/package.json
@@ -23,7 +23,9 @@
"lint:ts": "tslint './src/**/*.ts*' --format stylish",
"lint:sass": "stylelint ./src/**/*.scss",
"start": "npm run start-dev",
- "start-dev": "webpack-dev-server --config=configs/webpack/dev.js"
+ "start-dev": "webpack-dev-server --config=configs/webpack/dev.js",
+ "contributors:add": "all-contributors add",
+ "contributors:generate": "all-contributors generate"
},
"devDependencies": {
"@babel/cli": "^7.1.2",