From 855ccf1bf8e6e7385e78f3d02f751f130e9943bf Mon Sep 17 00:00:00 2001
From: jas0ncn <me@ijason.cc>
Date: Sun, 28 Oct 2018 00:46:51 +0800
Subject: [PATCH] Update readme and add contributors

---
 .all-contributorsrc | 59 +++++++++++++++++++++++++++++++++++++
 README.md           | 71 +++++++++++++++++++++++++++++++++++++++++++--
 package.json        |  4 ++-
 3 files changed, 131 insertions(+), 3 deletions(-)
 create mode 100644 .all-contributorsrc

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
+<h1 align="center">
+    <img src="https://github.com/Dreamacro/clash/raw/master/docs/logo.png" alt="Clash" width="200">
+    <br>
+    Clash Dashboard
+    <br>
+</h1>
 
-web port of clash
+<h4 align="center">Web Dashboard for Clash, now host on ClashX(Dev Mode)</h4>
+
+<p align="center">
+    <a href="https://travis-ci.org/Dreamacro/clash-dashboard">
+        <img src="https://travis-ci.org/Dreamacro/clash-dashboard.svg?branch=master" alt="Travis-CI">
+    </a>
+</p>
+
+## 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
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore -->
+| [<img src="https://avatars2.githubusercontent.com/u/3380894?v=4" width="100px;"/><br /><sub><b>Jason Chen</b></sub>](https://ijason.cc)<br />[🎨](#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") | [<img src="https://avatars1.githubusercontent.com/u/8615343?v=4" width="100px;"/><br /><sub><b>Dreamacro</b></sub>](https://github.com/Dreamacro)<br />[💻](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") | [<img src="https://avatars1.githubusercontent.com/u/12679581?v=4" width="100px;"/><br /><sub><b>chs97</b></sub>](http://www.hs97.cn)<br />[💻](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") | [<img src="https://avatars3.githubusercontent.com/u/11733500?v=4" width="100px;"/><br /><sub><b>Yicheng</b></sub>](https://github.com/yichengchen)<br />[🤔](#ideas-yichengchen "Ideas, Planning, & Feedback") [📦](#platform-yichengchen "Packaging/porting to new platform") |
+| :---: | :---: | :---: | :---: |
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+## 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",