Skip to content

Commit d318776

Browse files
committed
docs: update readme about umd files
1 parent 5f36601 commit d318776

File tree

3 files changed

+7
-10
lines changed

3 files changed

+7
-10
lines changed

CHANGELOG.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
- 🔥 introduce an official plugin `enum-plus-plugin` that provides a collection of highly shareable plugins.
1515
- These plugins are designed to work in all scenarios and environments (including browser and Node.js), without introducing dependencies on third-party frameworks, component libraries, or platforms.
1616
- If you have a good idea that might be specific to a certain framework or platform rather than universally applicable, we recommend creating a new plugin project (e.g., `enum-plus-plugin-xxx`). We are happy to see that, and hope that you submit a PR to `enum-plus-plugin` to link your project back.
17+
- ✨ Includes the `UMD` module format in this release, which allows you to use `enum-plus` in a browser environment without the need for a module bundler. This is particularly useful for quick prototyping or when working with legacy codebases that do not support modern module systems. You can find them in the `umd` directory of the package. They can also be downloaded in [github release](https://github.com/shijistar/enum-plus/releases) assets.
1718

1819
### Breaking Changes
1920

@@ -57,10 +58,6 @@
5758

5859
- ✨ Enhance the type inference of the `raw` method. When the input value matches a specific enum item, it only returns the raw object of that enum item instead of returning the raw objects of all enum items.
5960

60-
### Bug Fixes
61-
62-
- 🐞 The output `lib` directory structure is incorrect. This will break legacy Node.js applications using the `CommonJS` module spec, while modern Node.js applications using the `NodeNext` module spec remain unaffected. This issue was introduced in `v2.2.7`. For node.js applications, it's strongly recommended to upgrade.
63-
6461
## 2.2.9
6562

6663
2025-4-20

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ yarn add enum-plus
7878
- The specific version:
7979

8080
```html
81-
<script src="https://cdn.jsdelivr.net/npm/enum-plus@v3.0.0/script>
81+
<script src="https://cdn.jsdelivr.net/npm/enum-plus@v3.0.0/umd/enum-plus.min.js"></script>
8282
```
8383

8484
- The latest version:
@@ -90,9 +90,9 @@ yarn add enum-plus
9090
⬇️ **Download**:
9191

9292
- [enum-plus.umd.min.js.gz](https://github.com/shijistar/enum-plus/releases/download/v3.0.0/enum-plus.umd.min.js.gz) (~2kB gzipped)
93-
- [enum-plus.umd.tar.gz](https://github.com/shijistar/enum-plus/releases/download/v3.0.0/enum-plus.umd.tar.gz) (including sourcemap)
93+
- [enum-plus.umd.tar.gz](https://github.com/shijistar/enum-plus/releases/download/v3.0.0/enum-plus.umd.tar.gz) (Full package with sourcemap)
9494

95-
> You can also download them in github release assets
95+
> You can also download them in [github release](https://github.com/shijistar/enum-plus/releases) assets
9696
9797
## Enum Initialization
9898

README.zh-CN.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ yarn add enum-plus
7878
- 特定版本:
7979

8080
```html
81-
<script src="https://cdn.jsdelivr.net/npm/enum-plus@v3.0.0/script>
81+
<script src="https://cdn.jsdelivr.net/npm/enum-plus@v3.0.0/umd/enum-plus.min.js"></script>
8282
```
8383

8484
- 最新版本:
@@ -90,9 +90,9 @@ yarn add enum-plus
9090
⬇️ **下载文件**:
9191

9292
- [enum-plus.umd.min.js.gz](https://github.com/shijistar/enum-plus/releases/download/v3.0.0/enum-plus.umd.min.js.gz) (~2kB gzipped)
93-
- [enum-plus.umd.tar.gz](https://github.com/shijistar/enum-plus/releases/download/v3.0.0/enum-plus.umd.tar.gz) (including sourcemap)
93+
- [enum-plus.umd.tar.gz](https://github.com/shijistar/enum-plus/releases/download/v3.0.0/enum-plus.umd.tar.gz) (完整包,包含 sourcemap)
9494

95-
> 你也可以去 Github 发布中下载这些文件
95+
> 你也可以去 [Github 发布](https://github.com/shijistar/enum-plus/releases) 中下载这些文件
9696
9797
## 枚举定义
9898

0 commit comments

Comments
 (0)