diff --git a/README.md b/README.md index 4f5bf21..be7654b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,55 @@ -# NSIS-Dumper - NSIS-Dumper is a tool designed to dump the contents of NSIS installation files for a variety of purposes. +

NSIS Dumper

+ +

+ Version + License + PRs Welcome +

+ +

+ A simple Rust project designed to statically dump NSIS installers for various purposes. +

+ +## Table of contents +- [About](#about) +- [Pictures](#pictures) +- [Installation](#installation) +- [Usage](#usage) +- [Contribute](#contribute) +- [License](#license) + +## About +This project is designed to facilitate malware analysis and reverse engineering. I created it for educational purposes and to contribute to my learning of the Rust language. + +## Pictures + +

+ picture +

+ +## Installation +* Clone the project: `git clone https://github.com/Yvainix/NSIS-Dumper.git` +* Go to the project directory: `cd NSIS-Dumper` +* Compile the project: `cargo run` + +Alternatively, you can download the pre-compiled executable from the [Releases](https://github.com/Yvainix/NSIS-Dumper/releases) section. +## Usage +* Run the project : `NSIS-Dumper.exe NSIS_file.exe` + +## Contribute +Contributions are welcome! Follow these steps to contribute to this project: +1. Fork the project. +2. Create a branch: `git checkout -b feature/NewFeature`. +3. Make the necessary changes and commit: `git commit -am 'Add new feature'`. +4. Push to branch: `git push origin feature/NewFeature` +5. Submit a pull request. + +## License +This project is licensed under the MIT licence. See the [LICENSE](LICENSE) file for more details. + +## Contact +Yvain Ramora - yvain@mailfence.com + +

+ Project created with ❤️ +

\ No newline at end of file diff --git a/img/screenshot.png b/img/screenshot.png new file mode 100644 index 0000000..7984115 Binary files /dev/null and b/img/screenshot.png differ