From 5d041b2fd380550c4bd9c1f566c56fe34b8ccae8 Mon Sep 17 00:00:00 2001 From: Donald Zou Date: Wed, 25 Sep 2024 18:01:05 +0800 Subject: [PATCH] Update README.md --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b0246f7..02888ed 100644 --- a/README.md +++ b/README.md @@ -21,14 +21,20 @@ wakatime

-

Monitoring WireGuard is not convenient, need to remote access to server and type wg show. That's why this project is being created, to view all configurations and manage them in a easy way.

-

With all these awesome features, while keeping it simple, easy to install and use

+

Monitoring WireGuard is not convenient, in most case, you'll need to login to your server and type wg show. That's why this project is being created, to view and manage all WireGuard configurations in a easy way.

+

With all these awesome features, while keeping it easy to install and use

This project is not affiliate to the official WireGuard Project

-

- Official Documentation ➡️ -

-

- I've moved the documentation to a new repo with a published site. It improved readability for you and easier to manage for me ;) -

+
+ +## [Official Documentation ➡️](https://donaldzou.github.io/WGDashboard-Documentation/) +> [!NOTE] +> To better manage documentation for this project. I've moved it to its own [repo](https://github.com/donaldzou/WGDashboard-Documentation). I will keep updating over there and leave this README only with important information. + +- [💡 Features](https://donaldzou.github.io/WGDashboard-Documentation/features.html) +- [📝 Requirements](https://donaldzou.github.io/WGDashboard-Documentation/requirements.html) +- [🛠 Install](https://donaldzou.github.io/WGDashboard-Documentation/install.html) +- [🪜 Usage](https://donaldzou.github.io/WGDashboard-Documentation/usage.html) +- [📖 API Documentation](https://donaldzou.github.io/WGDashboard-Documentation/api-documentation.html) +- [And much more...](https://donaldzou.github.io/WGDashboard-Documentation/)