Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bbepis authored Jul 31, 2021
1 parent 9889004 commit bd9f5da
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,15 @@
# NStrip
.NET Assembly stripper, publicizer and general utility tool

## Usage
The general usage of NStrip is `NStrip [options] <input> <output>`. Input and output can be a file or a folder, but they have to match.

- `-h` prints help text.
- `-p` sets all types, methods, properties and fields to public.
- `-n` does not strip assemblies. If not used in conjunction with `-p`, this tool will write nothing.
- `-d <folder>` specifies a folder that contains additional dependencies for the target assemblies, if they are currently not in the same folder as the target assembly. Mono.Cecil will fail to output files if it cannot find all dependencies for the target assemblies. Can be specified multiple times
- `-b` is a blacklist for type name publicization. For example, `-b "Type"` will prevent types with the name "Type" from becoming public, which can help if types that are publicizised conflict with already public types and can cause issues with compilation.
- `-o` will overwrite target assemblies instead of appending `-nstrip` to the end of the filename. Does nothing if `<output>` is specified.

## Credits
Uses NArgs from https://github.com/bbepis/NArgs

0 comments on commit bd9f5da

Please sign in to comment.