doc: update readme (eggjs#87)

andylei18 · Sep 2, 2016 · 66e92fd · 66e92fd
1 parent e89080b
commit 66e92fd
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -15,6 +15,7 @@ docs/README.md
 docs/db.json
 docs/source/release/index.md
 docs/**/contributing.md
+docs/member_guide.md
 docs/public
 
 !test/fixtures/apps/loader-plugin/node_modules
diff --git a/README.md b/README.md
@@ -24,23 +24,48 @@ A web framework's framework for Node.js.
 
 ## Installation
 
+
 ```bash
 $ npm install egg --save
 ```
 
-Egg is supported in node v4+.
+Node >= 4.0.0 required, check [document for installation](https://eggjs.org/guide/installation.html).
 
 ## Features
 
+- ✔︎ Build-in process management
+- ✔︎ Plugin system
+- ✔︎ Framework customization
+- ✔︎ Lots of [plugins](https://eggjs.org/plugins/)
+
 ## Docs & Community
 
+- [Website](https://eggjs.org)
+- [Plugin List](https://eggjs.org/plugins/)
+- [Badgeboard](https://eggjs.org/badgeboard/)
+- [Frameworks](https://eggjs.org/frameworks.html)
+
 ## Getting Started
 
+Follow the step
+
+```bash
+$ npm install egg-init -g
+$ egg-init --type simple showcase && cd showcase
+$ npm install
+$ npm run dev
+$ open http://localhost:7001
+```
+
 ## Examples
 
 ## How to Contribute
 
-## Team
+Please let us know what we can help, check [issues](https://github.com/eggjs/egg/issues) for bug reporting and suggestion.
+
+If you are a contributor, follow [CONTRIBUTING](CONTRIBUTING.md).
+
+If you are a member of egg, follow [MEMBER_GUIDE](MEMBER_GUIDE.md).
 
 ## License
 

diff --git a/docs/source/_data/guide_toc.yml b/docs/source/_data/guide_toc.yml
@@ -15,4 +15,5 @@ Advanced:
 Community:
   Contributing: /contributing.html
   Member Guide: /member_guide.html
+  Frameworks: /frameworks.html
   FAQ: /faq.html
diff --git a/docs/source/frameworks.md b/docs/source/frameworks.md
diff --git a/docs/source/guide/installation.md b/docs/source/guide/installation.md
@@ -0,0 +1,2 @@
+title: Installation
+---
diff --git a/docs/themes/egg/languages/en.yml b/docs/themes/egg/languages/en.yml
@@ -25,4 +25,5 @@ guide_toc:
   Community: Community
   Contributing: Contributing
   "Member Guide": "Member Guide"
+  Frameworks: Frameworks
   FAQ: FAQ
diff --git a/docs/themes/egg/languages/zh-cn.yml b/docs/themes/egg/languages/zh-cn.yml
@@ -22,4 +22,5 @@ guide_toc:
   Community: 社区
   Contributing: 如何共享
   "Member Guide": 成员指南
+  Frameworks: 框架
   FAQ: 常见问题