From aa99586f9a15d03a8cd7d18f8b430e87026a146a Mon Sep 17 00:00:00 2001 From: Peter Berg Date: Mon, 27 Mar 2017 12:25:29 -0400 Subject: [PATCH] Cleans up introduce.en-Us.md (#5517) Fixes some small grammatical errors and makes some of the english sound more natural. --- docs/react/introduce.en-US.md | 37 ++++++++++++++++------------------- 1 file changed, 17 insertions(+), 20 deletions(-) diff --git a/docs/react/introduce.en-US.md b/docs/react/introduce.en-US.md index ddd47f7bed..22ba2191ee 100644 --- a/docs/react/introduce.en-US.md +++ b/docs/react/introduce.en-US.md @@ -3,7 +3,7 @@ order: 0 title: Ant Design of React --- -Following Ant Design specification, We develop a React UI library `antd` that contains a set of high quality components and demos for building rich interactive desktop applications. +Following the Ant Design specification, we developed a React UI library `antd` that contains a set of high quality components and demos for building rich, interactive user interfaces.
@@ -29,12 +29,12 @@ Following Ant Design specification, We develop a React UI library `antd` that co - An enterprise-class UI design language for web applications. - A set of high-quality React components out of the box. -- Written in TypeScript with complete define types. +- Written in TypeScript with complete defined types. - A npm + webpack + [dva](https://github.com/dvajs/dva) front-end development workflow. ## Environment Support -* Browser: Modern browsers and Internet Explorer 9+ +* Modern browsers and Internet Explorer 9+ * Server-side Rendering * [Electron](http://electron.atom.io/) @@ -43,13 +43,13 @@ Following Ant Design specification, We develop a React UI library `antd` that co - Stable: [![npm package](https://img.shields.io/npm/v/antd.svg?style=flat-square)](https://www.npmjs.org/package/antd) - Beta: [![](https://cnpmjs.org/badge/v/antd.svg?&tag=beta&subject=npm)](https://www.npmjs.org/package/antd) -You can subscribe to this feed for new version notification: https://github.com/ant-design/ant-design/releases.atom +You can subscribe to this feed for new version notifications: https://github.com/ant-design/ant-design/releases.atom ## Installation ### Using npm or yarn -**We recommend using npm or yarn to install**，it not only makes development easier，but you can also take advantage of the whole ecosystem. +**We recommend using npm or yarn to install**，it not only makes development easier，but also allow you to take advantage of the rich ecosystem of javascript packages and tooling. ```bash $ npm install antd --save @@ -63,11 +63,11 @@ If you are in a bad network enviornment，you can try other registers and tools ### Import in Browser -Add `script` and `link` tag in your browser and use global variable `antd`. +Add `script` and `link` tags in your browser and use the global variable `antd`. -We provide `antd.js` `antd.css` and `antd.min.js` `antd.min.css` under `antd/dist` in antd's npm package. Also you can download from [![CDNJS](https://img.shields.io/cdnjs/v/antd.svg?style=flat-square)](https://cdnjs.com/libraries/antd) or [unpkg](https://unpkg.com/). +We provide `antd.js` `antd.css` and `antd.min.js` `antd.min.css` under `antd/dist` in antd's npm package. You can also download these files directly from [![CDNJS](https://img.shields.io/cdnjs/v/antd.svg?style=flat-square)](https://cdnjs.com/libraries/antd) or [unpkg](https://unpkg.com/). -> **We are strongly not recommended to use these built files**, that make you import all components with large size, and you cannot get bugfixes from the dependencies of antd. +> **We strongly discourage loading these entire files** this will add bloat to your application and make it more difficult to receive bugfixes and updates. Ant is intended to be used in conjunction with a built a tool, such as [webpack](https://webpack.github.io/), which will make it easy to import only the parts of antd that you are using. ## Usage @@ -76,7 +76,7 @@ import { DatePicker } from 'antd'; ReactDOM.render(, mountNode); ``` -And import style manually: +And import stylesheets manually: ```jsx import 'antd/dist/antd.css'; // or 'antd/dist/antd.less' @@ -95,7 +95,7 @@ import 'antd/dist/antd.css'; // or 'antd/dist/antd.less' } ``` - Then you can import components from antd, equivalent to import manually below. + This allows you to import components from antd without having to manually import the corresponding stylesheet. The antd babel plugin will automatically import stylesheets. ```jsx // import js and css modularly, parsed by babel-plugin-import @@ -125,7 +125,7 @@ import 'antd/dist/antd.css'; // or 'antd/dist/antd.less' > Note: > - set `allowSyntheticDefaultImports` to prevent `error TS1192: Module 'react' has no default export`. -> - Don't use @types/antd, antd provide a built-in ts definition already. +> - Don't use @types/antd, antd provides a built-in ts definition already. ## Links @@ -144,7 +144,7 @@ import 'antd/dist/antd.css'; // or 'antd/dist/antd.less' - [Awesome Ant Design](https://github.com/websemantics/awesome-ant-design) - [Customize Theme](/docs/react/customize-theme) -## Who are using antd +## Companies using antd - [Ant Financial](http://www.antgroup.com/index.htm?locale=en_US) - [Alibaba](http://www.alibaba.com/) @@ -152,22 +152,19 @@ import 'antd/dist/antd.css'; // or 'antd/dist/antd.less' - [Meituan](http://www.meituan.com) - [Didi](http://www.xiaojukeji.com/) -> If your company or product uses Ant Design, you are welcome to comment in [this issue](https://github.com/ant-design/ant-design/issues/477). Thank you! +> If your company or product uses Ant Design, let us know [here](https://github.com/ant-design/ant-design/issues/477)! ## Contributing Please read our [CONTRIBUTING.md](https://github.com/ant-design/ant-design/blob/master/.github/CONTRIBUTING.md) first. -If you have any idea to improve antd, just create a [Pull Request](https://github.com/ant-design/ant-design/pulls). Also, you can also [issue](https://github.com/ant-design/ant-design/issues/new) bugs. +If you'd like to help us improve antd, just create a [Pull Request](https://github.com/ant-design/ant-design/pulls). Feel free to report bugs and issues [here](https://github.com/ant-design/ant-design/issues/new). -> Recommend to read [*How To Ask Questions The Smart Way*](http://www.catb.org/~esr/faqs/smart-questions.html) and [How to Ask a Question in Open Source Community](https://github.com/seajs/seajs/issues/545) and [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html), a smart question will get right answer quickly. +> If you're new to posting issues, we ask that you read [*How To Ask Questions The Smart Way*](http://www.catb.org/~esr/faqs/smart-questions.html) and [How to Ask a Question in Open Source Community](https://github.com/seajs/seajs/issues/545) and [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html) prior to posting. Well written bug reports help us help you! ## Need Help? -You can ask questions while you meet problem through the following ways. -And we encourage experienced users to help those who are not familiar with `antd`. +For questions on how to use antd, please post questions to [stackoverflow](http://stackoverflow.com/questions/tagged/antd) using the `antd` tag. If you're not finding what you need on stackoverflow, you can find us on [gitter](https://gitter.im/ant-design/ant-design?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) as well. -We recommend to tag your questions with `antd` on Stack Overflow. +As always, we encourage experienced users to help those who are not familiar with `antd`! -1. [Stack Overflow](http://stackoverflow.com/questions/tagged/antd)(Recommended) -2. [![Join the chat at https://gitter.im/ant-design/ant-design](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ant-design/ant-design?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)