SkuldNorniern / fluere

Fluere is a powerful and versatile tool designed for network monitoring and analysis. It is capable of capturing network packets in pcap format and converting them into NetFlow data, providing a comprehensive view of network traffic. It also Provides Terminal User Interface.
Apache License 2.0
29 stars 3 forks source link

Organize README #56

Closed sweep-ai[bot] closed 10 months ago

sweep-ai[bot] commented 10 months ago

Description

This PR aims to organize the README file by removing outdated information and irrelevant sections. The old "Usage" section and other irrelevant parts have been removed to keep the documentation up-to-date and relevant for users.

Summary

Fixes #55.


To checkout this PR branch, run the following command in your terminal:

git checkout {pull_request.branch_name}

πŸŽ‰ Latest improvements to Sweep:


πŸ’‘ To get Sweep to edit this pull request, you can:

SkuldNorniern commented 10 months ago

keep the Examples of Common Use Cases section

sweep-ai[bot] commented 10 months ago

keep the Examples of Common Use Cases section

Hi @SkuldNorniern,

I decided to make the following changes:

File Path Proposed Changes
README.md Modify README.md with contents:
β€’ Restore the "Examples of Common Use Cases" section in the README.md file.
SkuldNorniern commented 10 months ago

on the Examples of Common Use Cases section, can you add the information for the live_fluereflow.rs

sweep-ai[bot] commented 10 months ago

on the Examples of Common Use Cases section, can you add the information for the live_fluereflow.rs

Hi @SkuldNorniern,

I decided to make the following changes:

File Path Proposed Changes
README.md Modify README.md with contents:
β€’ Add the information from the live_fluereflow.rs file to the "Examples of Common Use Cases" section.
SkuldNorniern commented 10 months ago

don't remove the section for the online command, add the online again while keeping the live mode description

sweep-ai[bot] commented 10 months ago

don't remove the section for the online command, add the online again while keeping the live mode description

Hi @SkuldNorniern,

I decided to make the following changes:

File Path Proposed Changes
README.md Modify README.md with contents:
β€’ Add back the "online" section to the README file, including the command usage and examples.
β€’ Modify the existing "live" section to include the information for the "online" command as well.