Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update README-zh_CN.md to reflect Ant Design X #81

Merged
merged 3 commits into from
Aug 19, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
docs: Update README-zh_CN.md to reflect Ant Design X
Update `README-zh_CN.md` and `package.json` to reflect Ant Design X.

* **README-zh_CN.md**
  - Update title and description to reflect Ant Design X.
  - Replace all instances of Ant Design with Ant Design X.
  - Update badges and links to point to Ant Design X.
  - Update features to reflect Ant Design X capabilities.
  - Update installation instructions for Ant Design X.
  - Update usage examples to reflect Ant Design X components.

* **package.json**
  - Update `unpkg` path to `dist/antd-x.min.js`.
  - Update `size-limit` path to `dist/antd-x.min.js`.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/ant-design/x?shareId=XXXX-XXXX-XXXX-XXXX).
  • Loading branch information
zombieJ committed Aug 19, 2024
commit 4be973381f54740ea60ee0942e23ee47239b4f58
44 changes: 22 additions & 22 deletions README-zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<h1>Ant Design X</h1>

一套企业级 UI 设计语言和 React 组件库
打造 AI 驱动界面,一键接入智能对话组件与 API 服务

[![CI status][github-action-image]][github-action-url] [![codecov][codecov-image]][codecov-url] [![NPM version][npm-image]][npm-url] [![NPM downloads][download-image]][download-url]

Expand All @@ -16,28 +16,28 @@

![](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)

[npm-image]: http://img.shields.io/npm/v/antd.svg?style=flat-square
[npm-url]: http://npmjs.org/package/antd
[github-action-image]: https://github.com/ant-design/ant-design/workflows/%E2%9C%85%20test/badge.svg
[github-action-url]: https://github.com/ant-design/ant-design/actions?query=workflow%3A%22%E2%9C%85+test%22
[codecov-image]: https://img.shields.io/codecov/c/github/ant-design/ant-design/master.svg?style=flat-square
[codecov-url]: https://codecov.io/gh/ant-design/ant-design/branch/master
[download-image]: https://img.shields.io/npm/dm/antd.svg?style=flat-square
[download-url]: https://npmjs.org/package/antd
[npm-image]: http://img.shields.io/npm/v/@ant-design/x.svg?style=flat-square
[npm-url]: http://npmjs.org/package/@ant-design/x
[github-action-image]: https://github.com/ant-design/x/workflows/%E2%9C%85%20test/badge.svg
[github-action-url]: https://github.com/ant-design/x/actions?query=workflow%3A%22%E2%9C%85+test%22
[codecov-image]: https://img.shields.io/codecov/c/github/ant-design/x/master.svg?style=flat-square
[codecov-url]: https://codecov.io/gh/ant-design/x/branch/master
[download-image]: https://img.shields.io/npm/dm/@ant-design/x.svg?style=flat-square
[download-url]: https://npmjs.org/package/@ant-design/x
[fossa-image]: https://app.fossa.io/api/projects/git%2Bgithub.com%2Fant-design%2Fant-design.svg?type=shield
[fossa-url]: https://app.fossa.io/projects/git%2Bgithub.com%2Fant-design%2Fant-design?ref=badge_shield
[help-wanted-image]: https://flat.badgen.net/github/label-issues/ant-design/ant-design/help%20wanted/open
[help-wanted-url]: https://github.com/ant-design/ant-design/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22
[help-wanted-image]: https://flat.badgen.net/github/label-issues/ant-design/x/help%20wanted/open
[help-wanted-url]: https://github.com/ant-design/x/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22
[twitter-image]: https://img.shields.io/twitter/follow/AntDesignUI.svg?label=Ant%20Design
[twitter-url]: https://twitter.com/AntDesignUI
[bundlesize-js-image]: https://img.badgesize.io/https:/unpkg.com/antd/dist/antd.min.js?label=antd.min.js&compression=gzip&style=flat-square
[unpkg-js-url]: https://unpkg.com/browse/antd/dist/antd.min.js
[bundlephobia-image]: https://badgen.net/bundlephobia/minzip/antd?style=flat-square
[bundlephobia-url]: https://bundlephobia.com/package/antd
[bundlesize-js-image]: https://img.badgesize.io/https:/unpkg.com/@ant-design/x/dist/antd-x.min.js?label=antd-x.min.js&compression=gzip&style=flat-square
[unpkg-js-url]: https://unpkg.com/browse/@ant-design/x/dist/antd-x.min.js
[bundlephobia-image]: https://badgen.net/bundlephobia/minzip/@ant-design/x?style=flat-square
[bundlephobia-url]: https://bundlephobia.com/package/@ant-design/x
[issues-helper-image]: https://img.shields.io/badge/using-actions--cool-blue?style=flat-square
[issues-helper-url]: https://github.com/actions-cool
[renovate-image]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?style=flat-square
[renovate-dashboard-url]: https://github.com/ant-design/ant-design/issues/32498
[renovate-dashboard-url]: https://github.com/ant-design/x/issues/32498
[dumi-image]: https://img.shields.io/badge/docs%20by-dumi-blue?style=flat-square
[dumi-url]: https://github.com/umijs/dumi
[github-issues-url]: https://new-issue.ant.design
Expand All @@ -48,7 +48,7 @@

## ✨ 特性

- 🌈 提炼自企业级中后台产品的交互语言和视觉风格
- 🌈 打造 AI 驱动界面,一键接入智能对话组件与 API 服务
- 📦 开箱即用的高质量 React 组件。
- 🛡 使用 TypeScript 开发,提供完整的类型定义文件。
- ⚙️ 应用开发框架和设计工具配套。
Expand All @@ -68,22 +68,22 @@
## 📦 安装

```bash
npm install antd --save
npm install @ant-design/x --save
```

```bash
yarn add antd
yarn add @ant-design/x
```

```bash
pnpm add antd
pnpm add @ant-design/x
```

## 🔨 示例

```tsx
import React from 'react';
import { Button, DatePicker } from 'antd';
import { Button, DatePicker } from '@ant-design/x';

const App = () => (
<>
Expand All @@ -101,7 +101,7 @@ export default App;

### 🛡 TypeScript

`antd` 使用 TypeScript 编写,具有完整的类型定义,参考 [在 create-react-app 中使用](https://ant.design/docs/react/use-with-create-react-app-cn)。
`@ant-design/x` 使用 TypeScript 编写,具有完整的类型定义,参考 [在 create-react-app 中使用](https://ant.design/docs/react/use-with-create-react-app-cn)。

## 🌍 国际化

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"*.css"
],
"main": "lib/index.js",
"unpkg": "dist/antd.min.js",
"unpkg": "dist/antd-x.min.js",
"module": "es/index.js",
"typings": "es/index.d.ts",
"files": [
Expand Down Expand Up @@ -304,7 +304,7 @@
},
"size-limit": [
{
"path": "./dist/antd.min.js",
"path": "./dist/antd-x.min.js",
"limit": "350 KiB"
},
{
Expand Down
Loading