Skip to content

Commit 720889c

Browse files
author
RandomCrocodile
committed
docs: update README with contributors section and fix badges for master
1 parent 5d9dcaf commit 720889c

1 file changed

Lines changed: 65 additions & 27 deletions

File tree

README.md

Lines changed: 65 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
1-
# ConfuserEx
1+
# ConfuserExx
22

3-
[![Build status][img_build]][build]
4-
[![Test status][img_test]][test]
5-
[![CodeFactor][img_codefactor]][codefactor]
6-
[![Gitter Chat][img_gitter]][gitter]
3+
[![CI][img_ci]][ci]
4+
[![CodeQL][img_codeql]][codeql]
75
[![MIT License][img_license]][license]
86

9-
ConfuserEx is a open-source protector for .NET applications.
10-
It is the successor of [Confuser][confuser] project.
7+
An actively maintained fork of [ConfuserEx][upstream] — an open-source protector for .NET applications.
8+
9+
> The original [mkaring/ConfuserEx][upstream] has been dormant since 2022. This fork includes bug fixes, new features, and modern .NET support.
1110
1211
## Features
1312

14-
* Supports .NET Framework 2.0/3.0/3.5/4.0/4.5/4.6/4.7/4.8
13+
* Supports .NET Framework 2.0/3.5/4.x, .NET Standard 2.0, .NET Core, .NET 5+/6/7/8+
1514
* Symbol renaming (Support WPF/BAML)
1615
* Protection against debuggers/profilers
1716
* Protection against memory dumping
@@ -23,41 +22,80 @@ It is the successor of [Confuser][confuser] project.
2322
* Embedding dependency
2423
* Compressing output
2524
* Extensible plugin API
26-
* Many more are coming!
25+
* Roslyn code analysis integration
26+
* Auto-detection of .NET runtime paths for modern framework support
27+
28+
## What's improved over upstream
29+
30+
* Fixed WPF resource renaming, .NET Standard obfuscation, control flow protection
31+
* Serialization-aware renaming (DataContract, DataMember, JsonProperty)
32+
* Graceful handling of external/unresolvable assemblies (no more crashes)
33+
* Auto-detection of .NET Core/5+/6/7/8+ runtime assembly paths
34+
* CLI `--snkey` and `--snkeypass` options for CI/CD signing
35+
* Wildcard module loading in `.crproj` files
36+
* Roslyn analyzers (NetAnalyzers + Roslynator) for code quality
37+
* GitHub Actions CI/CD with automatic releases
38+
* Better error messages for .NET 6+ native host executables
2739

28-
# Usage
40+
## Usage
2941

30-
```Batchfile
42+
```bash
3143
Confuser.CLI.exe <path to project file>
3244
```
3345

3446
The project file is a ConfuserEx Project (`*.crproj`).
35-
The format of project file can be found in [docs\ProjectFormat.md][project_format]
47+
The format of project file can be found in [docs/ProjectFormat.md][project_format].
3648

37-
# Bug Report
49+
### CLI Options
50+
51+
```
52+
-n|noPause : no pause after finishing protection
53+
-o|out : specifies output directory
54+
-probe : specifies probe directory
55+
-plugin : specifies plugin path
56+
-debug : specifies debug symbol generation
57+
-snkey : specifies strong name key file path
58+
-snkeypass : specifies strong name key password
59+
```
3860

39-
See the [Issues Report][issues] section of website.
61+
## Bug Report
4062

41-
# License
63+
See the [Issues][issues] section. Please check existing issues before filing a new one.
64+
65+
## Contributing
66+
67+
1. Fork the repository
68+
2. Create a feature branch from `pre-release`
69+
3. Make your changes and ensure CI passes
70+
4. Open a PR targeting `pre-release`
71+
72+
## License
4273

4374
Licensed under the MIT license. See [LICENSE.md][license] for details.
4475

45-
# Credits
76+
## Contributors
77+
78+
<a href="https://github.com/mcpolo99/ConfuserExx/graphs/contributors">
79+
<img src="https://contrib.rocks/image?repo=mcpolo99/ConfuserExx" />
80+
</a>
81+
82+
## Credits
4683

47-
**[0xd4d]** for his awesome work and extensive knowledge!
84+
**[0xd4d]** for [dnlib][dnlib] and extensive .NET metadata knowledge.
85+
**[Ki (yck1509)][ki]** for the original ConfuserEx.
86+
**[Martin Karing][mkaring]** for maintaining the project through v1.6.
4887

4988
[0xd4d]: https://github.com/0xd4d
50-
[build]: https://ci.appveyor.com/project/mkaring/confuserex/branch/master
51-
[codefactor]: https://www.codefactor.io/repository/github/mkaring/confuserex/overview/master
52-
[confuser]: http://confuser.codeplex.com
89+
[dnlib]: https://github.com/0xd4d/dnlib
90+
[ki]: https://github.com/yck1509
91+
[mkaring]: https://github.com/mkaring
92+
[upstream]: https://github.com/mkaring/ConfuserEx
93+
[ci]: https://github.com/mcpolo99/ConfuserExx/actions/workflows/ci.yml
94+
[codeql]: https://github.com/mcpolo99/ConfuserExx/actions/workflows/codeql-analysis.yml
5395
[issues]: https://github.com/mcpolo99/ConfuserExx/issues
54-
[gitter]: https://gitter.im/ConfuserEx/community
5596
[license]: LICENSE.md
5697
[project_format]: docs/ProjectFormat.md
57-
[test]: https://ci.appveyor.com/project/mkaring/confuserex/branch/master/tests
5898

59-
[img_build]: https://img.shields.io/appveyor/ci/mkaring/ConfuserEx/master.svg?style=flat
60-
[img_codefactor]: https://www.codefactor.io/repository/github/mkaring/confuserex/badge/master
61-
[img_gitter]: https://img.shields.io/gitter/room/mkaring/ConfuserEx.svg?style=flat
62-
[img_license]: https://img.shields.io/github/license/mkaring/ConfuserEx.svg?style=flat
63-
[img_test]: https://img.shields.io/appveyor/tests/mkaring/ConfuserEx/master.svg?style=flat&compact_message
99+
[img_ci]: https://github.com/mcpolo99/ConfuserExx/actions/workflows/ci.yml/badge.svg?branch=master
100+
[img_codeql]: https://github.com/mcpolo99/ConfuserExx/actions/workflows/codeql-analysis.yml/badge.svg
101+
[img_license]: https://img.shields.io/github/license/mcpolo99/ConfuserExx.svg?style=flat

0 commit comments

Comments
 (0)