Skip to content

Commit

Permalink
chore: 🧹 Update links and some texts
Browse files Browse the repository at this point in the history
  • Loading branch information
AntwortEinesLebens committed Nov 3, 2024
1 parent 8fdc306 commit 3f3fed6
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@ SPDX-License-Identifier: GPL-3.0-or-later
-->

<div align="center">
<a href="https://github.com/frack113/WAG/">
<img src="https://raw.githubusercontent.com/frack113/WAG/main/media/logo.svg" alt="Logo" />
<a href="https://github.com/frack113/MalwareTracesGenerator/">
<img src="https://raw.githubusercontent.com/frack113/MalwareTracesGenerator/refs/heads/main/media/logo.svg" alt="Logo" />

Check failure on line 9 in README.md

View workflow job for this annotation

GitHub Actions / Lint with markdownlint-cli2

Line length

README.md:9:81 MD013/line-length Line length [Expected: 80; Actual: 125] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md
</a>

<h3 align="center">Windows Artifacts Generator</h3>
<h3 align="center">Malware Traces Generator</h3>

<p align="center">
Generate malware artifacts for detection tests
Generate malware traces for detection tests
<br />
<a href="https://github.com/frack113/WAG/issues/">
<a href="https://github.com/frack113/MalwareTracesGenerator/issues/">
Report Bug
</a>
·
<a href="https://github.com/frack113/WAG/issues/">
<a href="https://github.com/frack113/MalwareTracesGenerator/issues/">
Request Feature
</a>
<br />
Expand Down Expand Up @@ -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.

Check failure on line 60 in README.md

View workflow job for this annotation

GitHub Actions / Lint with markdownlint-cli2

Line length

README.md:60:81 MD013/line-length Line length [Expected: 80; Actual: 90] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md

### ❓ Why

It's useful for testing configurations, rules, or your Endpoint Detection and Response. \

Check failure on line 64 in README.md

View workflow job for this annotation

GitHub Actions / Lint with markdownlint-cli2

Line length

README.md:64:81 MD013/line-length Line length [Expected: 80; Actual: 89] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md
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. \

Check failure on line 65 in README.md

View workflow job for this annotation

GitHub Actions / Lint with markdownlint-cli2

Line length

README.md:65:81 MD013/line-length Line length [Expected: 80; Actual: 117] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md
By avoiding full and complex simulations, [Malware Traces Generator][mtg] seeks to be simple but nonetheless powerful.

Check failure on line 66 in README.md

View workflow job for this annotation

GitHub Actions / Lint with markdownlint-cli2

Line length

README.md:66:81 MD013/line-length Line length [Expected: 80; Actual: 118] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md

## 🚀 Getting started

Expand All @@ -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

```

Expand All @@ -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!
Expand All @@ -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].
Expand Down Expand Up @@ -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/

0 comments on commit 3f3fed6

Please sign in to comment.