update readme

README.md

@@ -1,65 +1,95 @@
 # Pangolin
 
-Pangolin is a self-hosted reverse proxy management server with identity and access management, designed to securely expose private resources through encrypted [WireGuard](https://www.wireguard.com/) tunnels. With Pangolin, you retain full control over your infrastructure while providing a user-friendly and feature-rich solution for managing proxies, authentication, and access, and simplifiy complex network setups.
+Pangolin is a self-hosted tunneled reverse proxy management server with identity and access management, designed to securely expose private resources through encrypted [WireGuard](https://www.wireguard.com/) tunnels running in user space. With Pangolin, you retain full control over your infrastructure while providing a user-friendly and feature-rich solution for managing proxies, authentication, and access, and simplifying complex network setups, all with a clean and simple UI.
 
----
+### Installation and Documentation
+
+-   [Installation Instructions](https://docs.fossorial.io)
+-   [Full Documentation](https://docs.fossorial.io)
 
 ## Key Features
 
-### Secure Reverse Proxy Management
+### Reverse Proxy Through WireGuard Tunnel
 
--   Expose private resources on your network without opening ports.
--   Built-in support for WireGuard tunnels for secure and efficient site-to-site connectivity.
--   Automated SSL certificates (https) via [LetsEncrypt](https://letsencrypt.org/).
+-   Expose private resources on your network **without opening ports**.
+-   Secure and easy to configure site-to-site connectivity via a custom **user space WireGuard client**, [Newt](https://github.com/fosrl/newt).
+-   Built-in support for any WireGuard client.
+-   Automated **SSL certificates** (https) via [LetsEncrypt](https://letsencrypt.org/).
 
 ### Identity & Access Management
 
--   Centralized authentication system using platform SSO. Users will only have to manage one login.
+-   Centralized authentication system using platform SSO. **Users will only have to manage one login.**
 -   Create organizations, each with multiple sites, users, and roles.
--   Role-based access control to manage resource access permissions.
--   Authentication options include:
-    -   Email whitelisting with one-time passcodes.
-    -   Temporary, self-destructing share links.
+-   **Role-based access control** to manage resource access permissions.
+-   Additional authentication options include:
+    -   Email whitelisting with **one-time passcodes.**
+    -   **Temporary, self-destructing share links.**
     -   Resource specific pin codes.
     -   Resource specific passwords.
 
+### Easy Deployment
+
+-   Docker Compose based setup for simplified deployment.
+-   Future-proof installation script for streamlined setup and feature additions.
+-   Run on any VPS.
+-   Use your preferred WireGuard client to connect, or use Newt, our custom user space client for the best experience.
+
 ### Modular Design
 
 -   Extend functionality with existing [Traefik](https://github.com/traefik/traefik) plugins, such as [Fail2Ban](https://plugins.traefik.io/plugins/628c9ebcffc0cd18356a979f/fail2-ban) or [CrowdSec](https://plugins.traefik.io/plugins/6335346ca4caa9ddeffda116/crowdsec-bouncer-traefik-plugin), which integrate seamlessly.
 -   Attach as many sites to the central server as you wish.
 
-### Flexible Deployment
+## Screenshots
 
--   Docker Compose-based setup for simplified deployment.
--   Future-proof installation script for streamlined setup and feature additions.
--   Run on any VPS.
--   Use your preferred WireGuard client to connect, or use Newt, our custom client for the best user experience.
+Pangolin has a straightforward and simple dashboard UI:
 
----
+<div align="center">
+  <table>
+  <tr>
+      <td align="center"><img src="public/screenshots/sites.png" alt="Sites Example" width="200"/></td>
+      <td align="center"><img src="public/screenshots/users.png" alt="Users Example" width="200"/></td>
+      <td align="center"><img src="public/screenshots/share-link.png" alt="Share Link Example" width="200"/></td>
+    </tr>
+    <tr>
+      <td align="center"><b>Sites</b></td>
+      <td align="center"><b>Users</b></td>
+      <td align="center"><b>Share Link</b></td>
+    </tr>
+    <tr>
+      <td align="center"><img src="public/screenshots/auth.png" alt="Authentication Example" width="200"/></td>
+      <td align="center"><img src="public/screenshots/connectivity.png" alt="Connectivity Example" width="200"/></td>
+    </tr>
+    <tr>
+      <td align="center"><b>Authentication</b></td>
+      <td align="center"><b>Connectivity</b></td>
+    </tr>
+  </table>
+</div>
 
 ## Workflow Example
 
 ### Deployment and Usage Example
 
-1. **Deploy the Central Server**:  
-   Deploy the Docker Compose stack containing Pangolin, Gerbil, and Traefik onto a VPS hosted on a cloud platform like Amazon EC2, DigitalOcean Droplet, or similar. There are many VPS hosting options available to suit your needs.
+1. **Deploy the Central Server**:
 
-2. **Domain Configuration**:  
-   Point your domain name to the VPS and configure Pangolin with your preferred settings.
+    - Deploy the Docker Compose stack containing Pangolin, Gerbil, and Traefik onto a VPS hosted on a cloud platform like Amazon EC2, DigitalOcean Droplet, or similar. There are many cheap VPS hosting options available to suit your needs.
 
-3. **Connect Private Sites**:
+2. **Domain Configuration**:
 
-    - Install Newt or use another WireGuard client on private sites.
-    - Establish a connection from these sites to the central server.
-    - This approach allows you to securely expose resources even in environments where the ISP prevents port forwarding.
+    - Point your domain name to the VPS and configure Pangolin with your preferred settings.
 
-4. **Use Case Example - Bypassing Port Restrictions**:  
-   Imagine private sites where the ISP restricts port forwarding. By connecting these sites to Pangolin via WireGuard, you can securely expose HTTP and HTTPS resources on the private network without any networking complexity.
+3. **Connect Private Sites**:
+    - Install Newt or use another WireGuard client on private sites.
+    - Automaticlaly establish a connection from these sites to the central server.
+4. **Configure Users & Roles**
+    - Define organizations and invite users.
+    - Implement user- or role-based permissions to control resource access.
 
-5. **Use Case Example - IoT Networks**:  
-   IoT networks are often fragmented and difficult to manage. By deploying Pangolin on a central server, you can connect all your IoT sites via Newt or another WireGuard client. This creates a simple, secure, and centralized way to access IoT resources without the need for intricate networking setups.
+**Use Case Example - Bypassing Port Restrictions in Home Lab**:  
+ Imagine private sites where the ISP restricts port forwarding. By connecting these sites to Pangolin via WireGuard, you can securely expose HTTP and HTTPS resources on the private network without any networking complexity.
 
----
+**Use Case Example - IoT Networks**:  
+ IoT networks are often fragmented and difficult to manage. By deploying Pangolin on a central server, you can connect all your IoT sites via Newt or another WireGuard client. This creates a simple, secure, and centralized way to access IoT resources without the need for intricate networking setups.
 
 ## Similar Projects and Inspirations
 
@@ -71,37 +101,6 @@ Pangolin was inspired by several existing projects and concepts:
 -   **Authentic and Authelia**:  
     These projects inspired Pangolin’s centralized authentication system for proxies, enabling robust user and role management.
 
----
-
-## Screenshots
-
-Here are some examples of Pangolin in action:
-
-<div align="center">
-  <table>
-    <tr>
-      <td align="center"><img src="public/screenshots/auth.png" alt="Authentication Example" width="200"/></td>
-      <td align="center"><img src="public/screenshots/connectivity.png" alt="Connectivity Example" width="200"/></td>
-      <td align="center"><img src="public/screenshots/share-link.png" alt="Share Link Example" width="200"/></td>
-    </tr>
-    <tr>
-      <td align="center"><b>Authentication</b></td>
-      <td align="center"><b>Connectivity</b></td>
-      <td align="center"><b>Share Link</b></td>
-    </tr>
-    <tr>
-      <td align="center"><img src="public/screenshots/sites.png" alt="Sites Example" width="200"/></td>
-      <td align="center"><img src="public/screenshots/users.png" alt="Users Example" width="200"/></td>
-    </tr>
-    <tr>
-      <td align="center"><b>Sites</b></td>
-      <td align="center"><b>Users</b></td>
-    </tr>
-  </table>
-</div>
-
----
-
 ## Technical Setup
 
 ### Components Overview
@@ -120,13 +119,11 @@ Pangolin’s architecture consists of the following components, each designed to
     - Out-of-the-box compatibility with plugins like Fail2Ban or CrowdSec.
     - Enhanced security via our custom Traefik plugin [**Badger**](https://github.com/fosrl/badger), which acts as an authentication bouncer.
 
-4. [**Newt**](https://github.com/fosrl/newt) (Minimal WireGuard Client):  
+4. [**Newt**](https://github.com/fosrl/newt) (Minimal User Space WireGuard Client):  
    A lightweight client designed to run on the private network. Newt:
     - Connects to the Pangolin server via WebSocket for managing endpoints.
     - Facilitates networking through its connection to Gerbil over the encrypted tunnel.
 
----
-
 ## Licensing
 
 Pangolin is released under the ... license. For inquiries about commercial licensing, please contact us.
@@ -134,4 +131,3 @@ Pangolin is released under the ... license. For inquiries about commercial licen
 ## Contributions
 
 Please see [CONTRIBUTIONS](./CONTRIBUTIONS.md) in the repository for guidelines and best practices.
-