Просмотр исходного кода

[WIP] Add README (#24)

* Add README

* update readme

* update emoji

* update screen shot

* fix list format

* update emoji

* fix list format

* update format

* update format

* update feature words
偏右 8 лет назад
Родитель
Сommit
8ec95ea0c2
3 измененных файлов с 84 добавлено и 7 удалено
  1. 45 0
      README.en-US.md
  2. 38 7
      README.md
  3. 1 0
      package.json

+ 45 - 0
README.en-US.md

@@ -0,0 +1,45 @@
+[简体中文](./README.md) | English
+
+# Ant Design Pro
+
+[![](https://img.shields.io/travis/ant-design/test2.svg?style=flat-square)](https://travis-ci.org/ant-design/test2)
+
+An out-of-box UI solution for enterprise applications.
+
+![](https://gw.alipayobjects.com/zos/rmsportal/UMpXlUaLSMJMhejrlREh.png)
+
+- Preview: http://preview.pro.ant.design
+- Home Page: http://pro.ant.design
+- Documentation: http://pro.ant.design/docs/getting-started
+- FAQ: http://pro.ant.design/docs/faq
+
+## Features
+
+- :gem: **Neat Design**: Follow Ant Design specification
+- :triangular_ruler: **Common Templates**: Typical templates for enterprise applications
+- :rocket: **State of The Art Development**: Newest development stack of React/dva/antd
+- :iphone: **Responsive**: Designed for varies of screen size
+- :art: **Themeing**: Customizable theme with simple config
+- :globe_with_meridians: **International**: Built-in i18n solution
+- :gear: **Best Practice**: Solid workflow make your code health
+- :1234: **Mock development**: Easy to use mock development solution
+- :white_check_mark: **UI Test**: Fly safely with unit test and e2e test
+
+## Usage
+
+```
+$ git clone git@github.com:ant-design/ant-design-pro
+$ cd ant-design-pro
+$ npm install
+$ npm start         // Visit http://127.0.0.1:8000
+```
+
+More instruction at [documentation](http://pro.ant.design/docs/getting-started)。
+
+## Contributing
+
+Any Contribution of following ways will be welcome:
+
+- Use Ant Design Pro in your daily work.
+- Submit [issues](http://github.com/ant-design/ant-design-pro/issues) to report bug or ask questions.
+- Propose [pull request](http://github.com/ant-design/ant-design-pro/pulls) to improve our code.

+ 38 - 7
README.md

@@ -1,14 +1,45 @@
-# XXX
+简体中文 | [English](./README.en-US.md)
+
+# Ant Design Pro
 
 
 [![](https://img.shields.io/travis/ant-design/test2.svg?style=flat-square)](https://travis-ci.org/ant-design/test2)
 [![](https://img.shields.io/travis/ant-design/test2.svg?style=flat-square)](https://travis-ci.org/ant-design/test2)
 
 
-## Development
+开箱即用的中台前端解决方案。
+
+![](https://gw.alipayobjects.com/zos/rmsportal/UMpXlUaLSMJMhejrlREh.png)
+
+- 预览:http://preview.pro.ant.design
+- 首页:http://pro.ant.design
+- 使用文档:http://pro.ant.design/docs/getting-started
+- 常见问题:http://pro.ant.design/docs/faq
+
+## 特性
+
+- :gem: **优雅美观**:基于 Ant Design 体系精心设计
+- :triangular_ruler: **常见设计模式**:提炼自中后台应用的典型页面和场景
+- :rocket: **最新技术栈**:使用 React/dva/antd 等前端前沿技术开发
+- :iphone: **响应式**:针对不同屏幕大小设计
+- :art: **主题**:可配置的主题满足多样化的品牌诉求
+- :globe_with_meridians: **国际化**:内建业界通用的国际化方案
+- :gear: **最佳实践**:良好的工程实践助您持续产出高质量代码
+- :1234: **Mock 数据**:实用的本地数据调试方案
+- :white_check_mark: **UI 测试**:自动化测试保障前端产品质量
+
+## 使用
 
 
-```bash
+```
+$ git clone git@github.com:ant-design/ant-design-pro
+$ cd ant-design-pro
 $ npm install
 $ npm install
-$ npm start
+$ npm start         // 访问 http://127.0.0.1:8000
 ```
 ```
 
 
-```bash
-$ npm run site
-```
+更多信息请参考 [使用文档](http://pro.ant.design/docs/getting-started)。
+
+## 参与贡献
+
+我们非常欢迎你的贡献,你可以通过以下方式参与:
+
+- 在你的公司或个人项目中使用 Ant Design Pro。
+- 通过 [issues](http://github.com/ant-design/ant-design-pro/issues) 给我们报告 bug 或进行咨询。
+- 给我们提交 [Pull Request](http://github.com/ant-design/ant-design-pro/pulls) 改进我们的代码。

+ 1 - 0
package.json

@@ -1,6 +1,7 @@
 {
 {
   "name": "ant-design-pro",
   "name": "ant-design-pro",
   "version": "0.9.0",
   "version": "0.9.0",
+  "description": "An out-of-box UI solution for enterprise applications",
   "private": true,
   "private": true,
   "scripts": {
   "scripts": {
     "precommit": "npm run lint-staged",
     "precommit": "npm run lint-staged",