doc: added space/dash in Bulk Barrage name

This commit is contained in:
Glenn Y. Rolland 2023-12-25 19:32:57 +01:00
parent 0023eb6033
commit fb8f5c6ee0

View file

@ -5,13 +5,13 @@
# Copyright © 2023 Glenn Y. Rolland <glenux@glenux.net>
-->
[![Build Status](https://cicd.apps.glenux.net/api/badges/glenux/bulkbarrage/status.svg)](https://cicd.apps.glenux.net/glenux/bulkbarrage)
[![Build Status](https://cicd.apps.glenux.net/api/badges/glenux/bulk-barrage/status.svg)](https://cicd.apps.glenux.net/glenux/bulk-barrage)
<img src="/glenux/bulkbarrage/raw/branch/master/_images/logo-simple.svg" height="256" />
<img src="/glenux/bulk-barrage/raw/branch/master/_images/logo-simple.svg" height="256" />
# Bulk Barrage
BulkBarrage is a command-line tool that enables users to report spam emails to
Bulk Barrage is a command-line tool that enables users to report spam emails to
the SignalSpam platform <signal-spam.fr>.
This tool serves as a bridge between individual users and the SignalSpam
@ -20,7 +20,7 @@ and action.
## Introduction
BulkBarrage is a community-driven project developed independently from
Bulk Barrage is a community-driven project developed independently from
SignalSpam. It offers a convenient way for users to report spam emails directly
from any email-piping capable mail client by leveraging the HTML forms on
SignalSpam's web platform. The project is currently in beta but is mature
@ -39,7 +39,7 @@ To build the project from source:
## Installation
To install BulkBarrage, follow these steps:
To install Bulk Barrage, follow these steps:
1. Ensure that CrystalLang is installed on your system.
2. Clone the repository:
@ -57,7 +57,7 @@ To install BulkBarrage, follow these steps:
## Usage
BulkBarrage can be used in a few simple steps:
Bulk Barrage can be used in a few simple steps:
```bash
Usage: bulkbarrage [options] [command]
@ -83,7 +83,7 @@ cat spam_email.eml | bulkbarrage report
Add the following code in your `~/.muttrc` configuration file.
```muttrc
macro index,pager \ez "<enter-command>set pipe_decode=no\n<pipe-entry>bulkbarrage report\n<enter-command>set pipe_decode=yes\n<delete-message>" "Report a spam using BulkBarrage"
macro index,pager \ez "<enter-command>set pipe_decode=no\n<pipe-entry>bulkbarrage report\n<enter-command>set pipe_decode=yes\n<delete-message>" "Report a spam using Bulk Barrage"
```
## Configuration
@ -94,7 +94,7 @@ with the SignalSpam platform.
## Issue Reporting
Issues can be reported on BulkBarrage's Issue Tracker.
Issues can be reported on Bulk Barrage's Issue Tracker.
## License