diff --git a/README.md b/README.md index 8d3881fdb..c33c487cc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -![](https://cloud.githubusercontent.com/assets/985607/16881873/c1612cf8-4aee-11e6-9b51-e95412750930.png) +![](https://raw.githubusercontent.com/eggjs/egg/master/docs/assets/egg-logo.png) -A web framework's framework for Node.js. +Born to build better enterprise frameworks and apps [![NPM version][npm-image]][npm-url] [![build status][travis-image]][travis-url] @@ -29,7 +29,7 @@ A web framework's framework for Node.js. $ npm install egg --save ``` -Node >= 4.0.0 required, check [document for installation](https://eggjs.org/guide/installation.html). +Node.js >= 4.0.0 required, check [document for installation](https://eggjs.org/guide/installation.html). ## Features diff --git a/README.zh-CN.md b/README.zh-CN.md index 6467f6d18..70a733c64 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -1,6 +1,6 @@ -![](https://cloud.githubusercontent.com/assets/985607/16881873/c1612cf8-4aee-11e6-9b51-e95412750930.png) +![](https://raw.githubusercontent.com/eggjs/egg/master/docs/assets/egg-logo.png) -Node.js 编写的 web 框架的框架。 +为企业级框架和应用而生 [![NPM version][npm-image]][npm-url] [![build status][travis-image]][travis-url] @@ -28,19 +28,43 @@ Node.js 编写的 web 框架的框架。 $ npm install egg --save ``` -Egg 支持 node v4 以上的版本。 +Node.js >= 4.0.0 required, check [document for installation](https://eggjs.org/guide/installation.html). ## 特性 +- ✔︎ Build-in process management +- ✔︎ Plugin system +- ✔︎ Framework customization +- ✔︎ Lots of [plugins](https://eggjs.org/plugins/) + ## 文档和社区 +- [Website](https://eggjs.org) +- [Plugin List](https://eggjs.org/plugins/) +- [Badgeboard](https://eggjs.org/badgeboard/) +- [Frameworks](https://eggjs.org/frameworks.html) + ## 快速开始 +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 +``` + ## 示例 ## 贡献代码 -## 团队 +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). ## 开源协议 diff --git a/docs/assets/egg-logo.png b/docs/assets/egg-logo.png new file mode 100644 index 000000000..dd5bb91fa Binary files /dev/null and b/docs/assets/egg-logo.png differ diff --git a/docs/logo/EGG-LOGO.psd b/docs/logo/EGG-LOGO.psd deleted file mode 100644 index a48e1ab11..000000000 Binary files a/docs/logo/EGG-LOGO.psd and /dev/null differ diff --git a/docs/logo/egg1.png b/docs/logo/egg1.png deleted file mode 100644 index 8fe38f11e..000000000 Binary files a/docs/logo/egg1.png and /dev/null differ diff --git a/docs/logo/egg10.png b/docs/logo/egg10.png deleted file mode 100644 index 6acde3c55..000000000 Binary files a/docs/logo/egg10.png and /dev/null differ diff --git a/docs/logo/egg11.png b/docs/logo/egg11.png deleted file mode 100644 index 1994e38c1..000000000 Binary files a/docs/logo/egg11.png and /dev/null differ diff --git a/docs/logo/egg2.png b/docs/logo/egg2.png deleted file mode 100644 index ccfc446e7..000000000 Binary files a/docs/logo/egg2.png and /dev/null differ diff --git a/docs/logo/egg3.png b/docs/logo/egg3.png deleted file mode 100644 index b50342f3f..000000000 Binary files a/docs/logo/egg3.png and /dev/null differ diff --git a/docs/logo/egg4.png b/docs/logo/egg4.png deleted file mode 100644 index fd188a5a0..000000000 Binary files a/docs/logo/egg4.png and /dev/null differ diff --git a/docs/logo/egg5.png b/docs/logo/egg5.png deleted file mode 100644 index 56f9418d9..000000000 Binary files a/docs/logo/egg5.png and /dev/null differ diff --git a/docs/logo/egg6.png b/docs/logo/egg6.png deleted file mode 100644 index de2dade6e..000000000 Binary files a/docs/logo/egg6.png and /dev/null differ diff --git a/docs/logo/egg7.png b/docs/logo/egg7.png deleted file mode 100644 index df2fdc97f..000000000 Binary files a/docs/logo/egg7.png and /dev/null differ diff --git a/docs/logo/egg8.png b/docs/logo/egg8.png deleted file mode 100644 index e34e39c84..000000000 Binary files a/docs/logo/egg8.png and /dev/null differ diff --git a/docs/logo/egg9.png b/docs/logo/egg9.png deleted file mode 100644 index 588cca754..000000000 Binary files a/docs/logo/egg9.png and /dev/null differ diff --git a/docs/logo/thumb.png b/docs/logo/thumb.png deleted file mode 100644 index deed9aedc..000000000 Binary files a/docs/logo/thumb.png and /dev/null differ diff --git a/docs/themes/egg/languages/en.yml b/docs/themes/egg/languages/en.yml index e2a97a354..d6e3ce0e8 100644 --- a/docs/themes/egg/languages/en.yml +++ b/docs/themes/egg/languages/en.yml @@ -5,14 +5,13 @@ menu: release: Release index: - title: "A web framework's framework for Node.js" - slogan: "Build Enterprise Web Application Simply" + slogan: "Born to build better enterprise frameworks and apps" feature11: "Process Management" feature12: "Built-in production process manager and load balancer" feature21: "Customization" feature22: "Customize framework for your team based on egg and plugins" feature31: "Powerful Plugin System" - feature32: "A pluggable and extendable system that do everything you like in egg" + feature32: "Do what you like in egg with the pluggable and extendable system" getstart: "Get Started" readmore: "Read More" diff --git a/docs/themes/egg/layout/index.swig b/docs/themes/egg/layout/index.swig index 239530b8a..682bd5f58 100644 --- a/docs/themes/egg/layout/index.swig +++ b/docs/themes/egg/layout/index.swig @@ -1,7 +1,7 @@