diff --git a/README.md b/README.md index bfe0706..ed70f11 100644 --- a/README.md +++ b/README.md @@ -5,20 +5,20 @@ SPDX-License-Identifier: GPL-3.0-or-later -->
- - Logo + + Logo -

Windows Artifacts Generator

+

Malware Traces Generator

- Generate malware artifacts for detection tests + Generate malware traces for detection tests
- + Report Bug ยท - + Request Feature
@@ -57,13 +57,13 @@ SPDX-License-Identifier: GPL-3.0-or-later ## ๐Ÿ‘€ About the project -[Windows Artifacts Generator][wag] is a tool for creating malware artifacts for detection tests. +[Malware Traces Generator][mtg] is a tool for creating malware traces for detection tests. ### โ“ Why It's useful for testing configurations, rules, or your Endpoint Detection and Response. \ -It's not intended to fully simulate the behavior of malware but to reproduce the steps that led to artifact creation. \ -By avoiding full and complex simulations, [Windows Artifacts Generator][wag] seeks to be simple but nonetheless powerful. +It's not intended to fully simulate the behavior of malware but to reproduce the steps that led to traces creation. \ +By avoiding full and complex simulations, [Malware Traces Generator][mtg] seeks to be simple but nonetheless powerful. ## ๐Ÿš€ Getting started @@ -80,7 +80,7 @@ Currently, this project is only available on [crates.io]. \ In order to install it, just enter this command in your favorite terminal: ```sh -cargo install windows-artifacts-generator +cargo install malware-traces-generator ``` @@ -89,7 +89,7 @@ cargo install windows-artifacts-generator 1. Clone the repository ```sh - git clone https://github.com/frack113/WAG/ + git clone https://github.com/frack113/MalwareTracesGenerator/ ``` 1. Build and run the project! @@ -102,17 +102,17 @@ After these steps, the application will be in the target directory. ### ๐Ÿฅท Quick examples -Now that [WAG] is installed, you can start generating some artifacts! \ +Now that [Malware Traces Generator][mtg] is installed, you can start generating some traces! \ For example, you can create a file like this: ```sh -wag actions files create --name "example.txt" +mtg actions files create --name "example.txt" ``` -Or you can generate artifacts from a configuration file: +Or you can generate traces from a configuration file: ```sh -wag generate --file "$YOUR_CONFIGURATIONS_FILE_PATH" +mtg generate --file "$YOUR_CONFIGURATIONS_FILE_PATH" ``` To see more information about what you can do, see the [documentation]. @@ -148,5 +148,5 @@ Distributed under the [GPL 3.0 or later] license. [gpl 3.0 or later]: ./LICENSES/GPL-3.0-or-later.txt [heroicons]: https://heroicons.com/ [mit]: ./LICENSES/MIT.txt +[mtg]: https://github.com/frack113/MalwareTracesGenerator/ [sil ofl]: ./LICENSES/OFL-1.1.txt -[wag]: https://github.com/frack113/WAG/