Skip to content

Commit

Permalink
Merge pull request #42 from frack113/chore/readme-line-length
Browse files Browse the repository at this point in the history
Chore/readme line length
  • Loading branch information
frack113 authored Nov 8, 2024
2 parents e8de2eb + a01cd1c commit bdb84a7
Showing 1 changed file with 21 additions and 9 deletions.
30 changes: 21 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ SPDX-License-Identifier: GPL-3.0-or-later

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

<h3 align="center">Malware Traces Generator</h3>
Expand All @@ -24,18 +25,23 @@ SPDX-License-Identifier: GPL-3.0-or-later
<br />
<br />
<a href="https://github.com/">
<!-- markdownlint-disable line-length -->
<img src="https://img.shields.io/badge/GitHub-181717?logo=github&logoColor=fff&style=for-the-badge" alt="Github badge" />
</a>
<a href="./LICENSES/GPL-3.0-or-later.txt">
<!-- markdownlint-disable line-length -->
<img src="https://img.shields.io/badge/License-GPL%203.0%20or%20later-green.svg?style=for-the-badge" alt="GPL 3.0 or later badge" />
</a>
<a href="https://www.microsoft.com/en-us/windows/">
<!-- markdownlint-disable line-length -->
<img src="https://img.shields.io/badge/Windows-0078D4?logo=windows&logoColor=fff&style=for-the-badge" alt="Windows badge" />
</a>
<a href="https://www.rust-lang.org/">
<!-- markdownlint-disable line-length -->
<img src="https://img.shields.io/badge/Rust-000?logo=rust&logoColor=fff&style=for-the-badge" alt="Rust badge" />
</a>
<a href="https://reuse.software/">
<!-- markdownlint-disable line-length -->
<img src="https://img.shields.io/reuse/compliance/github.com%2Ffrack113%2FWAG?style=for-the-badge" alt="Reuse badge" />
</a>
</p>
Expand All @@ -57,26 +63,30 @@ SPDX-License-Identifier: GPL-3.0-or-later

## 👀 About the project

[Malware Traces Generator][mtg] is a tool for creating malware traces 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 traces creation. \
By avoiding full and complex simulations, [Malware Traces Generator][mtg] seeks to be simple but nonetheless powerful.
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 traces creation.\
By avoiding full and complex simulations, [Malware Traces Generator][mtg] seeks
to be simple but nonetheless powerful.

## 🚀 Getting started

This is an example of how you can install or build the project yourself.

### ⚙️ Prerequisites

Depending on what you want to achieve, you might need different tools. \
Depending on what you want to achieve, you might need different tools.\
For now, you only need [Cargo] to build or install the project.

### 📦 Installation

Currently, this project is only available on [crates.io]. \
Currently, this project is only available on [crates.io].\
In order to install it, just enter this command in your favorite terminal:

```sh
Expand All @@ -102,7 +112,8 @@ After these steps, the application will be in the target directory.

### 🥷 Quick examples

Now that [Malware Traces Generator][mtg] is installed, you can start generating some traces! \
Now that [Malware Traces Generator][mtg] is installed, you can start generating
some traces!\
For example, you can create a file like this:

```sh
Expand All @@ -119,7 +130,8 @@ To see more information about what you can do, see the [documentation].

## 👷 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. \
Contributions are what make the open source community such an amazing place to
learn, inspire, and create.\
Any contributions you make are **greatly appreciated**.

If you want, you can help me with any kind of work, for example:
Expand Down

0 comments on commit bdb84a7

Please sign in to comment.