From 2de4dc2ac1dd14a50ad376179d744a2a99f5466c Mon Sep 17 00:00:00 2001 From: Glenn Date: Sun, 24 Dec 2023 17:07:23 +0100 Subject: [PATCH] doc: update name in README --- README.md | 38 ++++++++++++++++++-------------------- 1 file changed, 18 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index f1073fc..d8b26c5 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@ -# ReportSpam +# BulkBarrage -ReportSpam is a command-line tool that enables users to report spam emails to -the SignalSpam platform. This tool serves as a bridge between individual users -and the SignalSpam service, facilitating the process of submitting spam for -investigation and action. +BulkBarrage is a command-line tool that enables users to report spam emails to +the SignalSpam platform . + +This tool serves as a bridge between individual users and the SignalSpam +service, facilitating the process of submitting spam for official investigation +and action. ## Introduction -ReportSpam is a community-driven project developed independently from +BulkBarrage 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 @@ -26,14 +28,14 @@ To build the project from source: ## Installation -To install ReportSpam, follow these steps: +To install BulkBarrage, follow these steps: 1. Ensure that CrystalLang is installed on your system. 2. Clone the repository: ```bash - git clone https://github.com/your-repo/reportspam.git - cd reportspam + git clone https://github.com/your-repo/bulkbarrage.git + cd bulkbarrage ``` 3. Use the Makefile to build the project: @@ -44,40 +46,36 @@ To install ReportSpam, follow these steps: ## Usage -ReportSpam can be used in a few simple steps: +BulkBarrage can be used in a few simple steps: ```bash -Usage: reportspam [options] [command] +Usage: bulkbarrage [options] [command] Commands: configure Initialize the configuration - send Process and report spam email (default: from STDIN) + report Process and report spam email (default: from STDIN) Options: - -h, --help Show this help + -h, --help Show this help ``` -- **Configure**: Set up your initial configuration for using ReportSpam. -- **Report**: Pipe an email into the tool to report it as spam. -- **Help**: Display the help message for more information. - ### Reporting Spam To report a spam email, you can use the `report` command: ```bash -cat spam_email.eml | reportspam send +cat spam_email.eml | bulkbarrage send ``` ## Configuration -After installation, run `reportspam configure` to set up your user +After installation, run `bulkbarrage configure` to set up your user configuration, which may include credentials or preferences for interacting with the SignalSpam platform. ## Issue Reporting -Issues can be reported on ReportSpam's Issue Tracker. +Issues can be reported on BulkBarrage's Issue Tracker. ## License