From ccad5cda3bb5a4fc8f4a2a4d7eb13df793e5c115 Mon Sep 17 00:00:00 2001
From: Rongjian Zhang <pd4d10@gmail.com>
Date: Tue, 12 Feb 2019 15:09:49 +0800
Subject: [PATCH] chore: add all-contributors config and README

---
 .all-contributorsrc | 23 +++++++++++++++++++++++
 README.md           | 40 ++++++++++++++++++++++++++++++----------
 2 files changed, 53 insertions(+), 10 deletions(-)
 create mode 100644 .all-contributorsrc

diff --git a/.all-contributorsrc b/.all-contributorsrc
new file mode 100644
index 0000000..12353e7
--- /dev/null
+++ b/.all-contributorsrc
@@ -0,0 +1,23 @@
+{
+  "projectName": "git-touch",
+  "projectOwner": "pd4d10",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": true,
+  "contributors": [
+    {
+      "login": "pd4d10",
+      "name": "Rongjian Zhang",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/9524411?v=4",
+      "profile": "https://github.com/pd4d10",
+      "contributions": [
+        "code"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7
+}
diff --git a/README.md b/README.md
index fc62d35..1f5a542 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,36 @@
-# git_touch
+# GitTouch
 
-A new Flutter project.
+Open source GitHub client built with Flutter
 
-## Getting Started
+## Contributing
 
-This project is a starting point for a Flutter application.
+### UI Design
 
-A few resources to get you started if this is your first Flutter project:
+GitTouch use Flutter's builtin material and cupertino widgets. If you have any thoughts about UI design, feel free to open an issue to discuss about it.
 
-- [Lab: Write your first Flutter app](https://flutter.io/docs/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://flutter.io/docs/cookbook)
+### Bug report
 
-For help getting started with Flutter, view our 
-[online documentation](https://flutter.io/docs), which offers tutorials, 
-samples, guidance on mobile development, and a full API reference.
+Please follow the issue template to submit a bug report. Report with a screenshot would be great.
+
+### Bug fixes or new feature
+
+We use Flutter `dev` channel, run following command to switch to it:
+
+```sh
+flutter channel dev
+```
+
+## Contributors
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore -->
+<table><tr><td align="center"><a href="https://github.com/pd4d10"><img src="https://avatars0.githubusercontent.com/u/9524411?v=4" width="100px;" alt="Rongjian Zhang"/><br /><sub><b>Rongjian Zhang</b></sub></a><br /><a href="https://github.com/pd4d10/git-touch/commits?author=pd4d10" title="Code">💻</a></td></tr></table>
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+## License
+
+MIT