Skip to content

Commit

Permalink
Update README.md with new features and screenshots
Browse files Browse the repository at this point in the history
- Added two new screenshots for the Network Stats window.
- Expanded the features section to include network usage statistics with charts and multi-language support.
- Introduced a new section for the Network Stats window detailing its functionality.
- Updated the Settings section to reflect language selection and startup options.
- Added a License section to clarify project licensing.

These changes enhance the documentation by providing users with a clearer understanding of the application's capabilities and visual elements.
  • Loading branch information
mucahit-sahin committed Jan 20, 2025
1 parent 75eb751 commit 8ab9333
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 3 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Mücahit Şahin

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
33 changes: 30 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ A lightweight, modern network monitoring widget for Windows that displays real-t
![Network Speed Widget](screenshots/widget.png)
![Network Usage Window](screenshots/networkusage.png)
![Network Stats Window 1](screenshots/networkstats1.png)
![Network Stats Window 2](screenshots/networkstats2.png)

## Features

Expand All @@ -14,6 +16,8 @@ A lightweight, modern network monitoring widget for Windows that displays real-t
- System tray integration with speed tooltip
- Per-application network usage monitoring
- Detailed view for individual application network usage
- Network usage statistics with charts (daily, weekly, monthly, yearly)
- Multi-language support (English, Turkish, German, Spanish, French, Italian, Japanese, Korean, Chinese)
- Draggable windows for flexible positioning
- Always-on-top display option
- Double-click to show/hide windows
Expand All @@ -36,9 +40,10 @@ A lightweight, modern network monitoring widget for Windows that displays real-t

- **Drag**: Click and drag to move the widget
- **Double-click**: Opens the Network Usage window
- **Triple-click**: Opens the Network Stats window
- **System Tray**:
- Double-click the tray icon to show the widget
- Right-click for menu options (Show/Exit)
- Right-click for menu options (Show/Network Stats/Exit)

### Network Usage Window

Expand All @@ -48,13 +53,28 @@ A lightweight, modern network monitoring widget for Windows that displays real-t
- Click and drag to move the window
- Click the X button to close

### Network Stats Window

- Shows network usage statistics with interactive charts
- Supports different time periods (daily, weekly, monthly, yearly)
- Displays total download and upload amounts
- Shows per-application network usage statistics
- Sortable application list
- Resizable window with minimize/maximize options

### Application Details Widget

- Shows real-time network speeds for a specific application
- Click and drag to move the widget
- Double-click or click X to close
- Always stays on top for easy monitoring

### Settings

- Language selection (9 languages supported)
- Start with Windows option
- Changes take effect after restart

## Building from Source

1. Clone the repository:
Expand All @@ -80,15 +100,22 @@ dotnet run

- C# / .NET 6.0
- WPF (Windows Presentation Foundation)
- MVVM Architecture
- MVVM Architecture (CommunityToolkit.Mvvm)
- Entity Framework Core with SQLite
- LiveCharts2 for data visualization
- Windows Performance Counters
- ETW (Event Tracing for Windows)

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Acknowledgments

- Icons by [Your Icon Source]
- Built with [CommunityToolkit.Mvvm](https://github.com/CommunityToolkit/dotnet)
- Charts powered by [LiveCharts2](https://github.com/beto-rodriguez/LiveCharts2)
- Database management with [Entity Framework Core](https://github.com/dotnet/efcore)
Binary file added screenshots/networkstats1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/networkstats2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshots/widget.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8ab9333

Please sign in to comment.