Merge pull request #9 from Coding/hackape/update-readme

update readme

Author: vangie

README-zh.md

@@ -1,27 +1,45 @@
 # Coding WebIDE
 
-本项目是为了能够一键启动 `WebIDE` 开源版而创建的，以 git 子模块的形式引用了另外的三个项目，分别是 WebIDE-Frontend、WebIDE-Frontend-Webjars、WebIDE-Backend。
+![](https://raw.githubusercontent.com/Coding/WebIDE/gh-pages/screenshots/import.png)
+
+![](https://raw.githubusercontent.com/Coding/WebIDE/gh-pages/screenshots/workspace.png)
+
+Coding WebIDE(https://ide.coding.net) 是 Coding 自主研发的在线集成开发环境 (IDE)。用户可以通过 WebIDE 创建项目的工作空间, 进行在线开发, 调试等操作。同时 WebIDE 集成了 Git 代码版本控制, 用户可以选择 Coding、GitHub、BitBucket 等任意的代码仓库。 WebIDE 还提供了分享开发环境的功能, 用户可以保存当前的开发环境, 分享给团队的其他成员。
 
 请诸位把 issues 提到对应的项目下，这样可以得到更及时的处理。前端请到 [WebIDE-Frontend](https://github.com/Coding/WebIDE-Frontend/issues)，后端请到 [WebIDE-Backend](https://github.com/Coding/WebIDE-Backend/issues).
 
+## 功能特色
+
+1. *全功能 Web Terminal*
+2. *语法加亮*
+3. *代码补全*
+4. *主题切换*
+5. *分割视图*
+6. *VIM／Emacs 模式*
+7. *实时预览*
+
+本项目是为了能够一键启动 `WebIDE` 开源版而创建的，以 git 子模块的形式引用了另外的三个项目，分别是 WebIDE-Frontend、WebIDE-Frontend-Webjars、WebIDE-Backend。
+
+
+
 ## 模块说明
 
-> **WebIDE-Frontend:** WebIDE 前端项目  
-> **WebIDE-Frontend-Webjars:** webjar 项目，用于将 WebIDE 前端打包成 webjar  
-> **WebIDE-Backend:** WebIDE 后端项目  
+> **WebIDE-Frontend:** WebIDE 前端项目
+> **WebIDE-Frontend-Webjars:** webjar 项目，用于将 WebIDE 前端打包成 webjar
+> **WebIDE-Backend:** WebIDE 后端项目
 
 ## Clone 项目
 
 首先 clone 本项目到本地，然后拉取子项目:
 
-> git submodule init  
+> git submodule init
 > git submodule update
 
 即可拉取子项目到本地。
 
 ## 运行环境
 
-**WebIDE Frontend 依赖 npm 做包管理，wepack 和 babel 做构建工具**  
+**WebIDE Frontend 依赖 npm 做包管理，wepack 和 babel 做构建工具**
 **WebIDE-Frontend-Webjars & WebIDE-Backend 项目依赖 maven**
 
 在编译、运行项目前，请保证环境依赖已被正确配置。
@@ -30,8 +48,7 @@
 
 本项目提供了一个脚本 `ide.sh`，用于编译、打包、运行项目：
 
-> **./ide.sh build:** 编译并打包前端项目  
+> **./ide.sh build:** 编译并打包前端项目
 > **./ide.sh run:** 启动项目
 
 启动完成后，默认端口为 8080，访问 localhost:8080 即可。
-

README.md

@@ -1,17 +1,35 @@
 # Coding WebIDE
 
+![](https://raw.githubusercontent.com/Coding/WebIDE/gh-pages/screenshots/import.png)
+
+![](https://raw.githubusercontent.com/Coding/WebIDE/gh-pages/screenshots/workspace.png)
+
+Coding WebIDE(https://ide.coding.net) is a cloud-based IDE developed by Coding Team.You can create your own workspace and develop projects here.WebIDE works fine with Git. You can use Coding、GitHub、BitBucket as your Git repository. Workspaces are powered by Docker Ubuntu containers.The development environment can be saved and shared to your team member.
+
+## Features
+
+1. *Built-In Terminal*
+2. *Syntax Highlighting*
+3. *Language Tools*
+4. *Themes*
+5. *Split View*
+6. *VIM／Emacs Mode*
+7. *Previews*
+
+Please submit issues to corresponding projects, that'll help us make issues tracking easier so that we can provide timely help to you. Submit frontend issues at [WebIDE-Frontend](https://github.com/Coding/WebIDE-Frontend/issues) and backend issues at [WebIDE-Backend](https://github.com/Coding/WebIDE-Backend/issues).
+
 [中文 README](https://github.com/Coding/WebIDE-Workspace/blob/master/README-zh.md)
 
 This is the entry point to setup and run the WebIDE Community Edition project. It includes other 3 repos as git submodules.
 
-Please submit issues to corresponding projects, that'll help us make issues tracking easier so that we can provide timely help to you. Submit frontend issues at [WebIDE-Frontend](https://github.com/Coding/WebIDE-Frontend/issues) and backend issues at [WebIDE-Backend](https://github.com/Coding/WebIDE-Backend/issues).
+
 
 
 ## Modules
 
-> [WebIDE-Frontend](https://github.com/Coding/WebIDE-Frontend) contains frontend code.  
-> [WebIDE-Frontend-Webjars](https://github.com/Coding/WebIDE-Frontend-Webjars) packs frontend to webjar.  
-> [WebIDE-Backend](https://github.com/Coding/WebIDE-Backend) contains backend code.  
+> [WebIDE-Frontend](https://github.com/Coding/WebIDE-Frontend) contains frontend code.
+> [WebIDE-Frontend-Webjars](https://github.com/Coding/WebIDE-Frontend-Webjars) packs frontend to webjar.
+> [WebIDE-Backend](https://github.com/Coding/WebIDE-Backend) contains backend code.
 
 
 ## How to clone
@@ -28,8 +46,8 @@ This will also clone the other 3 repos via git submodule mechanism.
 
 ## Environment
 
-WebIDE Frontend uses `npm` for package management, `webpack` and `babel` for building.  
-WebIDE Frontend Webjars & WebIDE Backend use `maven`.  
+WebIDE Frontend uses `npm` for package management, `webpack` and `babel` for building.
+WebIDE Frontend Webjars & WebIDE Backend use `maven`.
 
 Please ensure you have corresponding tools installed in your environment before build and run the project.
 
@@ -38,7 +56,7 @@ Please ensure you have corresponding tools installed in your environment before
 
 We provide a shell script `ide.sh` to ease the build and run process
 
-> **./ide.sh build:** builds the frontend and packs to webjars  
+> **./ide.sh build:** builds the frontend and packs to webjars
 > **./ide.sh run:** start the backend and server
 
 Server runs on port 8080 by default, visit localhost:8080 to check it out. Have fun!