From 83c180a1637745ff0c7972e1ef13a2416480225b Mon Sep 17 00:00:00 2001 From: Mosder Date: Thu, 23 Jul 2026 17:45:22 +0200 Subject: feat: updated README.md to reflect what's implemented --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 780548b..c10b3de 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,11 @@ Unless you value FOSS or have troubles setting up BrokenHUD on your linux system ## Features - Capturing packets sent by the game and saving them to a file for later use - -### Planned features - Analyzer for the `.pcap` files containing captured packets: - List of fight results in the given file with rewards gained for each player + +### Planned features +- File analysis: - Total gained rewards in all fights in the given file - Live analyzer parsing packets in real time: - Results of the last fight @@ -80,20 +81,20 @@ branal (l | live) ``` It will open the live analyzer in your terminal. -### File analyzer (NOT IMPLEMENTED) -To analize a `.pcap` file, use: +### File analyzer +To analize `.pcap` files, use: ``` -branal (f | file) +branal (f | file) ``` -It will perform analysis of the specified ``. +It will perform analysis of the specified file(s). ### Capturing packets To just capture packets from the server, use: ``` branal (c | capture) [file] ``` -It will start capturing packets to the specified `[file]`. -If `[file]` is not specified, it will capture them to the default location (`~/.local/share/branal/captures`). +It will start capturing packets to the specified file. +If file is not specified, it will capture them to the default location (`~/.local/share/branal/captures`). ### Help You can display help using: -- cgit v1.2.3