Skip to content

Commit cdd225b

Browse files
committed
Docs: Improve readme
1 parent 70e8cd2 commit cdd225b

File tree

3 files changed

+24
-25
lines changed

3 files changed

+24
-25
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@
6060

6161
## 🚀 Why NETworkManager?
6262

63-
NETworkManager is your go-to tool for simplifying network administration and troubleshooting. Whether you're a sysadmin maintaining multiple servers, a network engineer in a large enterprise, or an IT enthusiast running your home lab, NETworkManager provides a powerful suite of tools to manage and diagnose your network infrastructure efficiently.
63+
NETworkManager is your go-to tool for simplifying network administration and troubleshooting. Whether you're a sysadmin maintaining company network with multiple servers, a network engineer in a large enterprise, or an IT enthusiast running your home lab, NETworkManager provides a powerful suite of tools to manage and diagnose your network infrastructure efficiently.
6464

6565
Here's why you'll love it:
6666

@@ -109,6 +109,8 @@ Install via package managers for a hassle-free setup:
109109
```
110110
Evergreen PowerShell module: <https://github.com/aaronparker/evergreen>
111111

112+
> Pre-release versions with the latest features and fixes are (sometimes) available for testing on [GitHub Releases](https://github.com/BornToBeRoot/NETworkManager/releases).
113+
112114
## 💖 Donate
113115

114116
NETworkManager is open source, free and without ads — developed in my spare time for you.
@@ -208,15 +210,19 @@ Star these projects to show your support!
208210
209211
## 🔒 Code Signing Policy
210212
211-
NETworkManager binaries are signed using [SignPath.io](https://signpath.io/) and a free certificate from [SignPath Foundation](https://signpath.org/). Builds are generated on [AppVeyor](https://ci.appveyor.com/project/BornToBeRoot/networkmanager) from the [GitHub repository](https://github.com/BornToBeRoot/NETworkManager/blob/main/appveyor.yml), signed via webhook after maintainer approval, and uploaded to [GitHub Releases](https://github.com/BornToBeRoot/NETworkManager/releases).
213+
NETworkManager uses free code signing services from [SignPath.io](https://signpath.io/) and a free code signing certificate provided by the [SignPath Foundation](https://signpath.org/) to sign all official binaries and installers, ensuring the authenticity and integrity of your downloads.
214+
215+
The binaries and installers are built on [AppVeyor](https://ci.appveyor.com/project/BornToBeRoot/networkmanager) directly from the [GitHub repository](https://github.com/BornToBeRoot/NETworkManager/blob/main/appveyor.yml). After each build, the artifacts are automatically sent to [SignPath.io](https://signpath.io/) via webhook, where they are signed following manual approval by the maintainer. Once signed, the binaries are uploaded to the [GitHub releases page](https://github.com/BornToBeRoot/NETworkManager/releases).
212216
213217
## 🔐 Privacy Policy
214218
215-
Your privacy matters. NETworkManager does not transfer data unless explicitly requested. Optional services (configurable at startup or in settings) include:
219+
Your privacy matters. NETworkManager will not transfer any information to other networked systems unless specifically requested by the user or the person installing or operating it.
220+
221+
NETworManager has integrated some optional third-party services to enhance functionality. You can choose to enable or disable these services at the first startup or later in the settings:
216222
217-
- [api.github.com](https://docs.github.com/en/site-policy/privacy-policies/github-general-privacy-statement) - Check for updates.
218-
- [ipify.org](https://www.ipify.org/) - Retrieve public IP.
219-
- [ip-api.com](https://ip-api.com/docs/legal) - Network information (e.g., geolocation, ISP).
223+
- [api.github.com](https://docs.github.com/en/site-policy/privacy-policies/github-general-privacy-statement) - Check for application updates.
224+
- [ipify.org](https://www.ipify.org/) - Retrieve the public IP address used by the client.
225+
- [ip-api.com](https://ip-api.com/docs/legal) - Retrieve network information (e.g., geolocation, ISP, DNS resolver) used by the client.
220226
221227
## 📝 License
222228

Website/docs/introduction.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@ import styles from "./styles.module.css";
1010

1111
Streamline and simplify your network administration and troubleshooting with <strong>NETworkManager</strong>. Connect, monitor, and troubleshoot your network and server infrastructure using built-in tools like Remote Desktop (RDP), PuTTY (SSH, Telnet, Serial), PowerShell (WinRM), TigerVNC (VNC), and AWS Session Manager. Perform in-depth network diagnostics with features including WiFi Analyzer, IP Scanner, Port Scanner, Ping Monitor, Traceroute, DNS Lookup, LLDP/CDP Capture, and [many more](./features) — all in a clean, unified interface.
1212

13-
Organize hosts and networks in encrypted profiles with seamless access across all features. Built for professional environments, NETworkManager is enterprise-ready with MSI installers, signed binaries, and support for package managers like Chocolatey, Evergreen, and WinGet. Available in over 16 languages with customizable light/dark themes and accent colors.
13+
Organize hosts and networks in encrypted profiles with seamless access across all features. Built for professional environments, NETworkManager is enterprise-ready with an MSI installer, signed binaries, and support for package managers like Chocolatey, Evergreen, and WinGet. Available in over 16 languages with customizable light/dark themes and accent colors.
1414

15-
![NETworkManager Preview](/img/preview.gif)
15+
![NETworkManager Preview](https://github.com/BornToBeRoot/NETworkManager/raw/main/Website/static/img/preview-features.gif?raw=true)

Website/src/pages/download.mdx

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ Install silent with the following command:
163163

164164
## Package Manager
165165

166-
NETworkManager is available through the following package managers.
166+
NETworkManager is available through the following package managers:
167167

168168
### Chocolatey
169169

@@ -197,7 +197,7 @@ Evergreen PowerShell module: [github.com/aaronparker/evergreen](https://github.c
197197

198198
## Pre-release
199199

200-
Features under development are (sometimes) available as pre-releases directly via [GitHub Releases](https://github.com/BornToBeRoot/NETworkManager/releases).
200+
Pre-release versions with the latest features and bug fixes are (sometimes) available for testing on [GitHub Releases](https://github.com/BornToBeRoot/NETworkManager/releases).
201201

202202
You can help to improve the software by testing pre-release versions and reporting bugs via [GitHub Issues](https://github.com/BornToBeRoot/NETworkManager/issues/new/choose).
203203

@@ -209,27 +209,20 @@ Please note that pre-release versions are not as stable as regular versions and
209209

210210
## Code Signing Policy
211211

212-
NETworkManager uses free code signing provided by [SignPath.io](https://signpath.io/) and a free code signing certificate
213-
from [SignPath Foundation](https://signpath.org/).
212+
NETworkManager uses free code signing services from [SignPath.io](https://signpath.io/) and a free code signing certificate provided by the [SignPath Foundation](https://signpath.org/) to sign all official binaries and installers, ensuring the authenticity and integrity of your downloads.
214213

215-
The binaries and installer are built on [AppVeyor](https://ci.appveyor.com/project/BornToBeRoot/networkmanager) directly from the [GitHub repository](https://github.com/BornToBeRoot/NETworkManager/blob/main/appveyor.yml).
216-
Build artifacts are automatically sent to [SignPath.io](https://signpath.io/) via webhook, where they are signed after manual approval by the maintainer.
217-
The signed binaries are then uploaded to the [GitHub releases](https://github.com/BornToBeRoot/NETworkManager/releases) page.
214+
The binaries and installers are built on [AppVeyor](https://ci.appveyor.com/project/BornToBeRoot/networkmanager) directly from the [GitHub repository](https://github.com/BornToBeRoot/NETworkManager/blob/main/appveyor.yml). After each build, the artifacts are automatically sent to [SignPath.io](https://signpath.io/) via webhook, where they are signed following manual approval by the maintainer. Once signed, the binaries are uploaded to the [GitHub releases page](https://github.com/BornToBeRoot/NETworkManager/releases).
218215

219216
## Privacy Policy
220217

221-
This program will not transfer any information to other networked systems unless specifically requested
222-
by the user or the person installing or operating it.
218+
Your privacy matters. NETworkManager will not transfer any information to other networked systems unless specifically requested by the user or the person installing or operating it.
223219

224-
NETworkManager has integrated the following services for additional functions, which can be enabled or
225-
disabled at the first start (in the welcome dialog) or at any time in the settings:
220+
NETworManager has integrated some optional third-party services to enhance functionality. You can choose to enable or disable these services at the first startup or later in the settings:
226221

227-
- [api.github.com](https://docs.github.com/en/site-policy/privacy-policies/github-general-privacy-statement) (Check for program updates)
228-
- [ipify.org](https://www.ipify.org/) (Retrieve the public IP address used by the client)
229-
- [ip-api.com](https://ip-api.com/docs/legal) (Retrieve network information such as geo location, ISP, DNS resolver used, etc. used by the client)
222+
- [api.github.com](https://docs.github.com/en/site-policy/privacy-policies/github-general-privacy-statement) - Check for application updates.
223+
- [ipify.org](https://www.ipify.org/) - Retrieve the public IP address used by the client.
224+
- [ip-api.com](https://ip-api.com/docs/legal) - Retrieve network information (e.g., geolocation, ISP, DNS resolver) used by the client.
230225

231226
## License
232227

233-
The code is open source and available on [GitHub](https://github.com/BornToBeRoot/NETworkManager) published under the [GNU General Public License v3](https://github.com/BornToBeRoot/NETworkManager/blob/main/LICENSE).
234-
235-
The licenses of the libraries used can be found [here](https://github.com/BornToBeRoot/NETworkManager/tree/main/Source/NETworkManager.Documentation/Licenses).
228+
NETworkManager is licensed under the [GNU General Public License v3](https://github.com/BornToBeRoot/NETworkManager/blob/main/LICENSE). Library licenses are [here](https://github.com/BornToBeRoot/NETworkManager/tree/main/Source/NETworkManager.Documentation/Licenses).

0 commit comments

Comments
 (0)