Skip to content

Commit 3262d0b

Browse files
authored
Merge pull request #252 from z0ffy/feat/update-docs
docs: update README and localization files with badge links and forma…
2 parents 108a3a8 + f65d2f4 commit 3262d0b

File tree

2 files changed

+26
-42
lines changed

2 files changed

+26
-42
lines changed

README.md

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,13 @@
77
JavaScript `obfuscator` plugin for `Vite` environments
88

99
[![awesome-vite](https://awesome.re/badge.svg)](https://github.com/vitejs/awesome-vite)
10-
[![][npm-release-shield]][npm-release-link]
11-
[![][npm-downloads-shield]][npm-release-link]
12-
[![][github-releasedate-shield]][github-releasedate-link]
13-
[![][github-license-shield]][github-license-link]
10+
[![npm version](https://img.shields.io/npm/v/vite-plugin-bundle-obfuscator?style=flat&colorA=18181B&colorB=28CF8D&logo=npm)](https://www.npmjs.com/package/vite-plugin-bundle-obfuscator)
11+
[![npm downloads](https://img.shields.io/npm/dt/vite-plugin-bundle-obfuscator?style=flat&colorA=18181B&colorB=28CF8D&logo=npm)](https://www.npmjs.com/package/vite-plugin-bundle-obfuscator)
12+
[![GitHub Release Date](https://img.shields.io/github/release-date/z0ffy/vite-plugin-bundle-obfuscator?style=flat&colorA=18181B&colorB=a855f7)](https://github.com/z0ffy/vite-plugin-bundle-obfuscator/releases)
13+
[![codecov](https://codecov.io/gh/z0ffy/vite-plugin-bundle-obfuscator/graph/badge.svg)](https://codecov.io/gh/z0ffy/vite-plugin-bundle-obfuscator)
14+
[![GitHub License](https://img.shields.io/github/license/z0ffy/vite-plugin-bundle-obfuscator?style=flat&colorA=18181B&colorB=white)](https://github.com/z0ffy/vite-plugin-bundle-obfuscator/blob/main/LICENSE)
1415

15-
[Changelog](./CHANGELOG.md) · [Report Bug][github-issues-link] · [Request Feature][github-pr-link]
16+
[📝 Changelog](./CHANGELOG.md) · [🐛 Report Bug][github-issues-link] · [Request Feature][github-pr-link]
1617

1718
<p align="center">
1819
<strong>English</strong> | <a href="./README.zh-CN.md">中文</a>
@@ -22,30 +23,21 @@ JavaScript `obfuscator` plugin for `Vite` environments
2223

2324
</div>
2425

25-
[npm-release-shield]: https://img.shields.io/npm/v/vite-plugin-bundle-obfuscator?color=369eff&labelColor=black&logo=npm&logoColor=white
26-
27-
[npm-downloads-shield]: https://img.shields.io/npm/dt/vite-plugin-bundle-obfuscator?color=red&labelColor=black&logo=npm&logoColor=white
28-
26+
<!-- Badge Links -->
27+
[npm-release-shield]: https://img.shields.io/npm/v/vite-plugin-bundle-obfuscator?style=flat&colorA=18181B&colorB=28CF8D&logo=npm
28+
[npm-downloads-shield]: https://img.shields.io/npm/dt/vite-plugin-bundle-obfuscator?style=flat&colorA=18181B&colorB=28CF8D&logo=npm
2929
[npm-release-link]: https://www.npmjs.com/package/vite-plugin-bundle-obfuscator
30-
31-
[github-releasedate-shield]: https://img.shields.io/github/release-date/z0ffy/vite-plugin-bundle-obfuscator?labelColor=black
32-
30+
[github-releasedate-shield]: https://img.shields.io/github/release-date/z0ffy/vite-plugin-bundle-obfuscator?style=flat&colorA=18181B&colorB=a855f7
3331
[github-releasedate-link]: https://github.com/z0ffy/vite-plugin-bundle-obfuscator/releases
34-
35-
[github-issues-shield]: https://img.shields.io/github/issues/z0ffy/vite-plugin-bundle-obfuscator?color=ff80eb&labelColor=black
36-
37-
[github-issues-link]: https://github.com/z0ffy/vite-plugin-bundle-obfuscator/issues
38-
39-
[github-license-shield]: https://img.shields.io/github/license/z0ffy/vite-plugin-bundle-obfuscator?color=white&labelColor=black
40-
32+
[github-license-shield]: https://img.shields.io/github/license/z0ffy/vite-plugin-bundle-obfuscator?style=flat&colorA=18181B&colorB=white
4133
[github-license-link]: https://github.com/z0ffy/vite-plugin-bundle-obfuscator/blob/main/LICENSE
42-
34+
[github-issues-link]: https://github.com/z0ffy/vite-plugin-bundle-obfuscator/issues
4335
[github-pr-link]: https://github.com/z0ffy/vite-plugin-bundle-obfuscator/pulls
4436

4537
## ⭐️ Features
4638

4739
- ✅ ⚡ Supports `JavaScript obfuscation` in `Vite` projects.
48-
- ✅ 🚀 Multi-threading support for better performfance.
40+
- ✅ 🚀 Multi-threading support for better performance.
4941
- ✅ ⚙️ Customizable obfuscator options to fit your needs.
5042
- ✅ 🛡️ Auto-excludes `node_modules`.
5143
- ✅ 📦 Support the `node_modules` split chunk.

README.zh-CN.md

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,13 @@
77
适用于`Vite`环境的`JavaScript`混淆器插件
88

99
[![awesome-vite](https://awesome.re/badge.svg)](https://github.com/vitejs/awesome-vite)
10-
[![][npm-release-shield]][npm-release-link]
11-
[![][npm-downloads-shield]][npm-release-link]
12-
[![][github-releasedate-shield]][github-releasedate-link]
13-
[![][github-license-shield]][github-license-link]
10+
[![npm version](https://img.shields.io/npm/v/vite-plugin-bundle-obfuscator?style=flat&colorA=18181B&colorB=28CF8D&logo=npm)](https://www.npmjs.com/package/vite-plugin-bundle-obfuscator)
11+
[![npm downloads](https://img.shields.io/npm/dt/vite-plugin-bundle-obfuscator?style=flat&colorA=18181B&colorB=28CF8D&logo=npm)](https://www.npmjs.com/package/vite-plugin-bundle-obfuscator)
12+
[![GitHub Release Date](https://img.shields.io/github/release-date/z0ffy/vite-plugin-bundle-obfuscator?style=flat&colorA=18181B&colorB=a855f7)](https://github.com/z0ffy/vite-plugin-bundle-obfuscator/releases)
13+
[![codecov](https://codecov.io/gh/z0ffy/vite-plugin-bundle-obfuscator/graph/badge.svg)](https://codecov.io/gh/z0ffy/vite-plugin-bundle-obfuscator)
14+
[![GitHub License](https://img.shields.io/github/license/z0ffy/vite-plugin-bundle-obfuscator?style=flat&colorA=18181B&colorB=white)](https://github.com/z0ffy/vite-plugin-bundle-obfuscator/blob/main/LICENSE)
1415

15-
[Changelog](./CHANGELOG.md) · [Report Bug][github-issues-link] · [Request Feature][github-pr-link]
16+
[📝 更新日志](./CHANGELOG.md) · [🐛 报告问题][github-issues-link] · [✨ 请求功能][github-pr-link]
1617

1718
<p align="center">
1819
<a href="./README.md">English</a> | <strong>中文</strong>
@@ -22,24 +23,15 @@
2223

2324
</div>
2425

25-
[npm-release-shield]: https://img.shields.io/npm/v/vite-plugin-bundle-obfuscator?color=369eff&labelColor=black&logo=npm&logoColor=white
26-
27-
[npm-downloads-shield]: https://img.shields.io/npm/dt/vite-plugin-bundle-obfuscator?color=red&labelColor=black&logo=npm&logoColor=white
28-
26+
<!-- Badge Links -->
27+
[npm-release-shield]: https://img.shields.io/npm/v/vite-plugin-bundle-obfuscator?style=flat&colorA=18181B&colorB=28CF8D&logo=npm
28+
[npm-downloads-shield]: https://img.shields.io/npm/dt/vite-plugin-bundle-obfuscator?style=flat&colorA=18181B&colorB=28CF8D&logo=npm
2929
[npm-release-link]: https://www.npmjs.com/package/vite-plugin-bundle-obfuscator
30-
31-
[github-releasedate-shield]: https://img.shields.io/github/release-date/z0ffy/vite-plugin-bundle-obfuscator?labelColor=black
32-
30+
[github-releasedate-shield]: https://img.shields.io/github/release-date/z0ffy/vite-plugin-bundle-obfuscator?style=flat&colorA=18181B&colorB=a855f7
3331
[github-releasedate-link]: https://github.com/z0ffy/vite-plugin-bundle-obfuscator/releases
34-
35-
[github-issues-shield]: https://img.shields.io/github/issues/z0ffy/vite-plugin-bundle-obfuscator?color=ff80eb&labelColor=black
36-
37-
[github-issues-link]: https://github.com/z0ffy/vite-plugin-bundle-obfuscator/issues
38-
39-
[github-license-shield]: https://img.shields.io/github/license/z0ffy/vite-plugin-bundle-obfuscator?color=white&labelColor=black
40-
32+
[github-license-shield]: https://img.shields.io/github/license/z0ffy/vite-plugin-bundle-obfuscator?style=flat&colorA=18181B&colorB=white
4133
[github-license-link]: https://github.com/z0ffy/vite-plugin-bundle-obfuscator/blob/main/LICENSE
42-
34+
[github-issues-link]: https://github.com/z0ffy/vite-plugin-bundle-obfuscator/issues
4335
[github-pr-link]: https://github.com/z0ffy/vite-plugin-bundle-obfuscator/pulls
4436

4537
## ⭐️ 特性
@@ -135,7 +127,7 @@ const allObfuscatorConfig = {
135127

136128
export default {
137129
plugins: [
138-
vitePluginBundleObfuscator(defaultObfuscatorConfig)
130+
vitePluginBundleObfuscator(allObfuscatorConfig)
139131
]
140132
};
141133

0 commit comments

Comments
 (0)