Skip to content

Commit 263e0a1

Browse files
authored
Merge pull request rsuite#14 from hiyangguo/master
update:README.md
2 parents 88dffbb + 583bb1f commit 263e0a1

File tree

2 files changed

+82
-49
lines changed

2 files changed

+82
-49
lines changed

README.md

Lines changed: 42 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,14 @@
1-
English | [中文版](https://github.com/rsuite/rsuite/blob/master/README_zh.md)
1+
English | [中文版][readm-cn]
22

33

44
<p align="center">
55
<a href="https://rsuitejs.com" target="_blank" rel="noopener noreferrer">
6-
<img width="100" src="https://user-images.githubusercontent.com/1203827/39026518-277950c4-4480-11e8-8109-42fbb0f2f7b5.png" alt="RSUITE logo">
6+
<img height="100" src="https://user-images.githubusercontent.com/15609339/39298633-53826e50-4979-11e8-99fa-fac162d0830e.png" alt="RSUITE logo">
77
</a>
88
</p>
99

1010

11-
# RSUITE
12-
13-
[![npm](https://badge.fury.io/js/rsuite.svg)](https://www.npmjs.com/package/rsuite)
14-
[![Travis](https://travis-ci.org/rsuite/rsuite.svg?branch=master)](https://travis-ci.org/rsuite/rsuite)
15-
[![Coverage Status](https://coveralls.io/repos/github/rsuite/rsuite/badge.svg?branch=next)](https://coveralls.io/github/rsuite/rsuite?branch=next)
16-
17-
[![Discord](https://img.shields.io/badge/Discord-Join%20chat%20%E2%86%92-738bd7.svg)](https://discord.gg/GmPXTH3)
18-
11+
[![npm][npm-svg]][npm-home] [![Travis][travis-svg]][travis-home] [![Coverage Status][coverage-svg]][travis-home] [![Discord][discord-svg]][discord-invite]
1912

2013
RSUITE (React Suite) is a set of react component libraries for enterprise system products. Built by HYPERS front-end team and UX team, mainly serving company's big data products.
2114

@@ -27,17 +20,17 @@ After three major revisions, a large number of components and rich functionality
2720
| ---- | ---- | ------- | ------ | ------ |
2821
| >=10 | >=14 | >= 45 | >= 49 | >= 10 |
2922

30-
- IE<=9 is no longer supported since RSUITE 3.0.
23+
- IE<=9 is no longer supported since RSUITE 3.0.
3124
- RSUITE is designed and implemented for use on modern desktop browsers rather than mobile browsers.
3225

3326
### UI Design
3427

35-
RSUITE Design Prototype and specification, click to [view](https://rsuitejs.com/design/index.html)
28+
RSUITE Design Prototype and specification, click to [view][rsuite-design]
3629

3730

3831
## Installation
3932

40-
RSUITE is available as an [npm package](https://www.npmjs.com/package/rsuite).
33+
RSUITE is available as an [npm package][npm-home].
4134

4235
```bash
4336
npm i rsuite --save
@@ -61,41 +54,64 @@ import '~rsuite/lib/less/index.less';
6154
ReactDOM.render(<Button>Button</Button>, mountNode);
6255
```
6356

64-
[**Live preview on CodeSandbox**](https://codesandbox.io/s/mo7jxvr9x9?from-embed)
57+
[**Live preview on CodeSandbox**][live-preview-on-codesandbox]
6558

6659
### Documentaion
6760

68-
You can go through [full documentation](https://rsuitejs.com/guide/introduction) or start with following sections
61+
You can go through [full documentation][rsuite-doc-guide] or start with following sections
6962

70-
* [Quick start](https://rsuitejs.com/guide/usage)
71-
* [Customizing themes](https://rsuitejs.com/guide/themes)
72-
* [Internationalization](https://rsuitejs.com/guide/intl)
73-
* [Components](https://rsuitejs.com/components/overview)
63+
* [Quick start][rsuite-doc-guide]
64+
* [Customizing themes][rsuite-doc-guide-themes]
65+
* [Internationalization][rsuite-doc-guide-intl]
66+
* [Components][rsuite-components-overview]
7467

7568

7669
## Changelog
7770

78-
Detailed changes for each release are documented in the [release notes](https://github.com/rsuite/rsuite/releases).
71+
Detailed changes for each release are documented in the [release notes][release-notes].
7972

8073

8174
## Contribution
8275

83-
Make sure you've read the [guidelines](https://github.com/rsuite/rsuite/blob/master/CONTRIBUTING.md) before you start contributing.
76+
Make sure you've read the [guidelines][contributing] before you start contributing.
8477

85-
Editor preferences are available in the [.prettierrc](https://github.com/rsuite/rsuite/wiki/.prettierrc) for easy use in common code editors. Read more and download plugins at https://prettier.io/.
78+
Editor preferences are available in the [.prettierrc][prettierrc] for easy use in common code editors. Read more and download plugins at https://prettier.io/.
8679

8780

8881
## Supporting RSUITE
8982

9083
If you like RSUITE, you can show your support by either
9184

9285
- Starring this repo
93-
- [Leaving a comment here](https://github.com/rsuite/rsuite/issues/11) if you are using RSUITE in your project (like we do :smile:)
94-
- Becomiong a backer on OpenCollective
86+
- [Leaving a comment here][issues-11] if you are using RSUITE in your project (like we do :smile:)
87+
- [Becomiong a backer][opencollective-home] on OpenCollective
9588

96-
[<img src="https://opencollective.com/rsuite/tiers/backer.svg?avatarHeight=36">](https://opencollective.com/rsuite)
89+
[![opencollective-now][opencollective-svg]][opencollective-home]
9790

9891

9992
## License
10093

101-
RSUITE is [MIT licensed](https://github.com/rsuite/rsuite/blob/master/LICENSE). Copyright (c) 2016-present, HYPERS
94+
RSUITE is [MIT licensed][LICENSE]. Copyright (c) 2016-present, HYPERS.
95+
96+
[readm-cn]:https://github.com/rsuite/rsuite/blob/master/README_zh.md
97+
[npm-svg]:https://badge.fury.io/js/rsuite.svg
98+
[npm-home]:https://www.npmjs.com/package/rsuite
99+
[travis-svg]:https://travis-ci.org/rsuite/rsuite.svg?branch=master
100+
[travis-home]:https://travis-ci.org/rsuite/rsuite
101+
[coverage-svg]:https://coveralls.io/repos/github/rsuite/rsuite/badge.svg?branch=master
102+
[travis-home]:https://coveralls.io/github/rsuite/rsuite?branch=master
103+
[discord-svg]:https://img.shields.io/badge/Discord-Join%20chat%20%E2%86%92-738bd7.svg
104+
[discord-invite]:https://discord.gg/GmPXTH3
105+
[rsuite-design]:https://rsuitejs.com/design/index.html
106+
[live-preview-on-codesandbox]:https://codesandbox.io/s/mo7jxvr9x9?from-embed
107+
[rsuite-doc-guide]:https://rsuitejs.com/guide/introduction
108+
[rsuite-doc-guide-themes]:https://rsuitejs.com/guide/themes
109+
[rsuite-doc-guide-intl]:https://rsuitejs.com/guide/intl
110+
[rsuite-components-overview]:https://rsuitejs.com/components/overview
111+
[release-notes]:https://github.com/rsuite/rsuite/releases
112+
[contributing]:https://github.com/rsuite/rsuite/blob/master/CONTRIBUTING.md
113+
[prettierrc]:https://github.com/rsuite/rsuite/wiki/.prettierrc
114+
[issues-11]:https://github.com/rsuite/rsuite/issues/11
115+
[opencollective-svg]:https://opencollective.com/rsuite/tiers/backer.svg?avatarHeight=36
116+
[opencollective-home]:https://opencollective.com/rsuite
117+
[LICENSE]:https://github.com/rsuite/rsuite/blob/master/LICENSE

README_zh.md

Lines changed: 40 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,14 @@
1-
[English](https://github.com/rsuite/rsuite/blob/master/README_zh.md) | 中文版
1+
[English][readm-en] | 中文版
22

33

44
<p align="center">
55
<a href="https://rsuitejs.com" target="_blank" rel="noopener noreferrer">
6-
<img width="100" src="https://user-images.githubusercontent.com/1203827/39026518-277950c4-4480-11e8-8109-42fbb0f2f7b5.png" alt="RSUITE logo">
6+
<img height="100" src="https://user-images.githubusercontent.com/15609339/39298633-53826e50-4979-11e8-99fa-fac162d0830e.png" alt="RSUITE logo">
77
</a>
88
</p>
99

1010

11-
# RSUITE
12-
13-
[![npm](https://badge.fury.io/js/rsuite.svg)](https://www.npmjs.com/package/rsuite)
14-
[![Travis](https://travis-ci.org/rsuite/rsuite.svg?branch=master)](https://travis-ci.org/rsuite/rsuite)
15-
[![Coverage Status](https://coveralls.io/repos/github/rsuite/rsuite/badge.svg?branch=next)](https://coveralls.io/github/rsuite/rsuite?branch=next)
16-
17-
[![Discord](https://img.shields.io/badge/Discord-Join%20chat%20%E2%86%92-738bd7.svg)](https://discord.gg/GmPXTH3)
11+
[![npm][npm-svg]][npm-home] [![Travis][travis-svg]][travis-home] [![Coverage Status][coverage-svg]][travis-home] [![Discord][discord-svg]][discord-invite]
1812

1913
RSUITE(React Suite 的简写)是一套 React 组件库,为后台产品而生。由 HYPERS 前端团队与 UX 团队打造,主要服务于公司大数据产品线。经历了三次大的版本更新后,累积了大量的组件和丰富的功能。
2014

@@ -29,12 +23,12 @@ RSUITE(React Suite 的简写)是一套 React 组件库,为后台产品而
2923

3024
### UI Design
3125

32-
RSUITE 设计原型与规范, [点击查看](https://rsuitejs.com/design/index.html)
26+
RSUITE 设计原型与规范, [点击查看][rsuite-design]
3327

3428

3529
## 安装
3630

37-
RSUITE 可通过 [npm](https://www.npmjs.com/package/rsuite) 安装.
31+
RSUITE 可通过 [npm][npm-home] 安装.
3832

3933
```bash
4034
npm i rsuite --save
@@ -53,41 +47,64 @@ import '~rsuite/lib/less/index.less';
5347
ReactDOM.render(<Button>Button</Button>, mountNode);
5448
```
5549

56-
你可以在 [CodeSandbox](https://codesandbox.io/s/mo7jxvr9x9?from-embed) 上查看该示例。
50+
你可以在 [CodeSandbox][live-preview-on-codesandbox] 上查看该示例。
5751

5852
### 文档
5953

60-
你可以阅读[完整文档](https://rsuitejs.com/guide/introduction),或者从下面几个章节开始学习
54+
你可以阅读[完整文档][rsuite-doc-guide],或者从下面几个章节开始学习
6155

62-
* [如何使用?](https://rsuitejs.com/guide/usage)
63-
* [自定义主题](https://rsuitejs.com/guide/themes)
64-
* [国际化](https://rsuitejs.com/guide/intl)
65-
* [组件](https://rsuitejs.com/components/overview)
56+
* [如何使用?][rsuite-doc-guide]
57+
* [自定义主题][rsuite-doc-guide-themes]
58+
* [国际化][rsuite-doc-guide-intl]
59+
* [组件][rsuite-components-overview]
6660

6761

6862
## 更新日志
6963

70-
详见 [Release Notes](https://github.com/rsuite/rsuite/releases)
64+
详见 [Release Notes][release-notes]
7165

7266

7367
## 贡献
7468

75-
请阅读[贡献指南](https://github.com/rsuite/rsuite/blob/master/CONTRIBUTING.zh-CN.md)
69+
请阅读[贡献指南][contributing]
7670

77-
编辑器的配置参考 [.prettierrc](https://github.com/rsuite/rsuite/wiki/.prettierrc), 下载编辑的插件 https://prettier.io/。
71+
编辑器的配置参考 [.prettierrc][prettierrc], 下载编辑的插件 https://prettier.io/。
7872

7973

8074
## 支持 RSUITE
8175

8276
如果你喜欢 RSUITE,可以通过以下方式支持我们
8377

8478
- Star 这个项目
85-
- 如果你在你的项目中使用了 RSUITE,欢迎在这里[留言](https://github.com/rsuite/rsuite/issues/11)
79+
- 如果你在你的项目中使用了 RSUITE,欢迎在这里[留言][issues-11]
8680
-[OpenCollective](https://opencollective.com/rsuite#) 上赞助我们
8781

88-
[<img src="https://opencollective.com/rsuite/tiers/backer.svg?avatarHeight=36">](https://opencollective.com/rsuite)
82+
[![opencollective-now][opencollective-svg]][opencollective-home]
8983

9084

9185
## License
9286

93-
RSUITE 基于 [MIT license](https://github.com/rsuite/rsuite/blob/master/LICENSE) 发布。
87+
RSUITE 基于 [MIT licensed][LICENSE] 发布。
88+
89+
[readm-en]:https://github.com/rsuite/rsuite/blob/master/README.md
90+
[npm-svg]:https://badge.fury.io/js/rsuite.svg
91+
[npm-home]:https://www.npmjs.com/package/rsuite
92+
[travis-svg]:https://travis-ci.org/rsuite/rsuite.svg?branch=master
93+
[travis-home]:https://travis-ci.org/rsuite/rsuite
94+
[coverage-svg]:https://coveralls.io/repos/github/rsuite/rsuite/badge.svg?branch=master
95+
[travis-home]:https://coveralls.io/github/rsuite/rsuite?branch=master
96+
[discord-svg]:https://img.shields.io/badge/Discord-Join%20chat%20%E2%86%92-738bd7.svg
97+
[discord-invite]:https://discord.gg/GmPXTH3
98+
[rsuite-design]:https://rsuitejs.com/design/index.html
99+
[live-preview-on-codesandbox]:https://codesandbox.io/s/mo7jxvr9x9?from-embed
100+
[rsuite-doc-guide]:https://rsuitejs.com/guide/introduction
101+
[rsuite-doc-guide-themes]:https://rsuitejs.com/guide/themes
102+
[rsuite-doc-guide-intl]:https://rsuitejs.com/guide/intl
103+
[rsuite-components-overview]:https://rsuitejs.com/components/overview
104+
[release-notes]:https://github.com/rsuite/rsuite/releases
105+
[contributing]:https://github.com/rsuite/rsuite/blob/master/CONTRIBUTING.zh-CN.md
106+
[prettierrc]:https://github.com/rsuite/rsuite/wiki/.prettierrc
107+
[issues-11]:https://github.com/rsuite/rsuite/issues/11
108+
[opencollective-svg]:https://opencollective.com/rsuite/tiers/backer.svg?avatarHeight=36
109+
[opencollective-home]:https://opencollective.com/rsuite
110+
[LICENSE]:https://github.com/rsuite/rsuite/blob/master/LICENSE

0 commit comments

Comments
 (0)