update docs before v1.3

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All Sniffnet releases with the relative changes are documented in this file.
 
-## [UNRELEASED]
+## [1.3.0] - 2024-04-08
 - Introduced thumbnail mode, enabling users to keep an eye on Sniffnet while doing other tasks ([#484](https://github.com/GyulyVGC/sniffnet/pull/484))
 - Added support for ICMP connections and messages ([#417](https://github.com/GyulyVGC/sniffnet/pull/417) — fixes [#288](https://github.com/GyulyVGC/sniffnet/issues/288))
 - Added capability to identify 6000+ upper layer services, protocols, trojans, and worms ([#450](https://github.com/GyulyVGC/sniffnet/pull/450) — fixes [#374](https://github.com/GyulyVGC/sniffnet/issues/374))

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-<p align="center"><a href="https://github.com/GyulyVGC/sniffnet"><img alt="Sniffnet" src="https://github.com/GyulyVGC/sniffnet/blob/main/resources/repository/header_repository.png?raw=true" width="100%"/></a></p>
+<p align="center"><a href="https://github.com/GyulyVGC/sniffnet"><img alt="" title="Sniffnet" src="https://github.com/GyulyVGC/sniffnet/blob/main/resources/repository/header_repository.png?raw=true" width="100%"/></a></p>
 
 # How can you contribute to the Sniffnet project?
 
@@ -28,6 +28,6 @@ Ensure the pull request description clearly describes the problem and your solut
 
 ## Are you willing to help but don't know where to start?
 
-You can give a look at the [project roadmap](https://github.com/GyulyVGC/sniffnet/blob/main/ROADMAP.md) to see the features I'd like to implement next, or check out issues labeled with the tag "[help wanted](https://github.com/GyulyVGC/sniffnet/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)" to see what I'm struggling with.
+You can give a look at the [project roadmap](https://github.com/GyulyVGC/sniffnet/blob/main/ROADMAP.md) to see the features I'd like to implement next, or check out issues labeled with the tag "[help wanted](https://github.com/GyulyVGC/sniffnet/labels/help%20wanted)" to see what I'm struggling with.
 
 All proposals to enlarge or improve Sniffnet are warmly welcomed, join the discussion and don't hesitate to share your thoughts!

README.md

@@ -169,20 +169,20 @@ tce-load -wi sniffnet
 
 ## Features
 
-- 💻 choose a network adapter of your PC to inspect
-- 🏷️ select a set of filters to apply to the observed traffic
-- 📖 view overall statistics about your Internet traffic
-- 📈 view real-time charts about traffic intensity
-- 📌 keep an eye on your network even when the application is minimized
-- 📁 export comprehensive capture reports as PCAP files
-- 🔎 identify 6000+ upper layer services, protocols, trojans, and worms
-- 🌐 find out domain name and ASN of the hosts you are exchanging traffic with
-- 🏠 identify connections in your local network
-- 🌍 get information about the country of remote hosts (IP geolocation)
-- ⭐ save your favorite network hosts
-- 🕵️‍♂️ search and inspect each of your network connections in real time
-- 🔉 set custom notifications to inform you when defined network events occur
-- 🎨 choose the style that fits you the most, including custom themes support
+- 💻 choose a **network adapter** of your PC to inspect
+- 🏷️ select a set of **filters** to apply to the observed traffic
+- 📖 view overall **statistics** about your Internet traffic
+- 📈 view **real-time charts** about traffic intensity
+- 📌 keep an eye on your network even when the application is **minimized**
+- 📁 **export** comprehensive capture reports as **PCAP files**
+- 🔎 identify **6000+ upper layer services**, protocols, trojans, and worms
+- 🌐 find out **domain name** and **ASN** of the hosts you are exchanging traffic with
+- 🏠 identify connections in your **local network**
+- 🌍 get information about the country of remote hosts (**IP geolocation**)
+- ⭐ save your **favorite** network hosts
+- 🕵️‍♂️ search and **inspect** each of your network connections in real time
+- 🔉 set **custom notifications** to inform you when defined network events occur
+- 🎨 choose the **style** that fits you the most, including custom themes support
 - ...and more!
 
 ## User manual

ROADMAP.md

@@ -11,35 +11,42 @@ Known open problems are reported at the bottom of this file.
 
 ## Major features
 
-Feature | Release | 
--|-|
-IP geolocation | ✅ (v1.1)
-Custom notifications | ✅ (v1.1)
-Host names and ASN availability | ✅ (v1.2)
-Full connections report in a dedicated page | ✅ (v1.2)
-Read and write of PCAP files | 🔜 (v1.3)
-ICMP support | 🔜 (v1.3)
-Packets' payload inspection | ❓(TBD)
-IP addresses' reputation | ❓(TBD)
-Malicious traffic detection | ❓(TBD)
-PIDs identification | ❓(TBD)
-Sniffnet agent to monitor a remote host | ❓(TBD)
+| Feature                                     | Release  | 
+|---------------------------------------------|----------|
+| IP geolocation                              | ✅ (v1.1) |
+| Custom notifications                        | ✅ (v1.1) |
+| Host names and ASN availability             | ✅ (v1.2) |
+| Full connections report in a dedicated page | ✅ (v1.2) |
+| Thumbnail mode                              | ✅ (v1.3) |
+| Extended upper layer services recognition   | ✅ (v1.3) |
+| ICMP support                                | ✅ (v1.3) |
+| PCAP file export                            | ✅ (v1.3) |
+| PCAP file import                            | ❓(TBD)   |
+| IP addresses' reputation                    | ❓(TBD)   |
+| Malicious traffic detection                 | ❓(TBD)   |
+| PIDs identification                         | ❓(TBD)   |
+| Packets' payload inspection                 | ❓(TBD)   |
+| Firewall capabilities                       | ❓(TBD)   |
+| Sniffnet agent to monitor a remote host     | ❓(TBD)   |
+| Web interface                               | ❓(TBD)   |
 
 ## Other features
 
-Feature | Release | 
--|-|
-Settings page: notifications, style, language | ✅ (v1.1.0)
-Keyboard shortcuts | ✅ (v1.1.2)
-Notify user when new release is available | ✅ (v1.1.3)
-Styles based on color gradients | ✅ (v1.2.2)
-Filter traffic by port number | 🔜 (v1.3.0)
-Advanced settings: UI scale factor and MMDBs paths | 🔜 (v1.3.0)
-Proper table structure for connections list | ❓(TBD)
-Filter inputs autocompletion | ❓(TBD)
-Details about unassigned IPs | ❓(TBD)
-Custom TOML themes support | ❓(TBD)
-Additional details about each notification event | ❓(TBD)
+| Feature                                            | Release    | 
+|----------------------------------------------------|------------|
+| Settings page: notifications, style, language      | ✅ (v1.1.0) |
+| Keyboard shortcuts                                 | ✅ (v1.1.2) |
+| Notify user when new release is available          | ✅ (v1.1.3) |
+| Styles based on color gradients                    | ✅ (v1.2.2) |
+| Custom TOML themes support                         | ✅ (v1.3.0) |
+| Filter traffic by port number                      | ✅ (v1.3.0) |
+| Advanced settings: UI scale factor and MMDBs paths | ✅ (v1.3.0) |
+| Proper table structure for connections list        | ✅ (v1.3.0) |
+| Extended documentation (Wiki)                      | ✅ (v1.3.0) |
+| Support more link types                            | ✅ (v1.3.0) |
+| Filter inputs autocompletion                       | ❓(TBD)     |
+| Details about unassigned IPs                       | ❓(TBD)     |
+| Additional details about each notification event   | ❓(TBD)     |
 
 ## Known problems
 
@@ -50,12 +57,6 @@ This section only contains currently open problems.
   - only the 30 top hosts are shown in GUI at the moment
 - Notifications startegy should be changed
   - too many notifications are delivered, related to similar events, in a short amount of time
-- Improve output report update strategy
-  - currently the output is generated once per second
-- Using the default renderer in some environments can cause some layout problems:
-  - flags are not renderer correctly (they appear black)
-  - the UI screen glitches
-  - see [this section](https://github.com/GyulyVGC/sniffnet#troubleshooting) to solve
 - Improve packages
   - remove previous version of Sniffnet in Windows
   - solve problems related to osascript on macOS