Skip to content

Commit 0c413ba

Browse files
committed
docs: update readme documentation
1 parent 69b36f3 commit 0c413ba

File tree

3 files changed

+24
-2
lines changed

3 files changed

+24
-2
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,17 @@ What other exciting features are there? Please continue to explore! Or you can c
4747
<img src="./public/usage-screenshot.gif" width="500" alt="usage video" />
4848
</p>
4949

50+
<details>
51+
<summary>Here are some hot questions, feel free to check them out</summary>
52+
53+
- [Why do I need this library? TypeScript already has the built-in enums](#why-do-i-need-this-library-typescript-already-has-the-built-in-enums)
54+
- [Do I have to install TypeScript? What if my project is in JavaScript?](#do-i-have-to-install-typescript-what-if-my-project-is-in-javascript)
55+
- [How about the performance of this library?](#how-about-the-performance-of-this-library)
56+
- [It seems that TypeScript is going to deprecate enum?](#it-seems-that-typescript-is-going-to-deprecate-enum)
57+
- [I have a great idea and would like to contribute to this project. What should I do?](#i-have-a-great-idea-and-would-like-to-contribute-to-this-project-what-should-i-do)
58+
59+
</details>
60+
5061
## Features
5162

5263
- Fully compatible with native `enum` usage
@@ -1208,7 +1219,7 @@ In Node.js environments, you can import enum-plus using either `require` or `imp
12081219

12091220
## Q&A
12101221

1211-
### Why do I need this library? TypeScript already has the built-in enum
1222+
### Why do I need this library? TypeScript already has the built-in enums
12121223

12131224
TypeScript's built-in enum only provides the basic functionality of [Enumeration](https://en.wikipedia.org/wiki/Enumerated_type): eliminating magic numbers, and regulating control flow. However, as a front-end engineer, the needs for enumerations are not merely these. We also need:
12141225

README.zh-CN.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,17 @@
4747
<img src="./public/usage-screenshot.gif" width="500" alt="usage video" />
4848
</p>
4949

50+
<details>
51+
<summary>这里有几个常见问题,有兴趣也可以阅读一下</summary>
52+
53+
- [为什么需要这个库?TypeScript 已经有内置的枚举了](#为什么需要这个库typescript-已经有内置的枚举了)
54+
- [我必须使用 TypeScript 吗?我的是 JavaScript 项目要怎么办?](#我必须使用-typescript-吗我的是-javascript-项目要怎么办)
55+
- [枚举库的性能怎么样?](#枚举库的性能怎么样)
56+
- [好像 TypeScript 要废弃 enum 了?](#好像-typescript-要废弃-enum-了)
57+
- [我有一个很好的点子,希望为这个项目做贡献,我要怎么做?](#我有一个很好的点子希望为这个项目做贡献我要怎么做)
58+
59+
</details>
60+
5061
## 特性
5162

5263
- 完全兼容原生 `enum` 的用法

packages/plugin-antd/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@enum-plus/plugin-antd",
3-
"version": "1.0.0-beta.0",
3+
"version": "1.0.0",
44
"description": "A plugin for enum-plus that provides functionality to bind enums to Ant Design",
55
"keywords": [
66
"enum",

0 commit comments

Comments
 (0)