From 7cfac7354d2d0e744b982ddae3bd2957e52d57e4 Mon Sep 17 00:00:00 2001 From: Arihant Jain <47983999+Arihant101@users.noreply.github.com> Date: Wed, 25 Mar 2026 02:33:16 -0400 Subject: [PATCH] Fix grammar and clarity issues in README.md Corrected minor grammatical errors and improved clarity in README.md. --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ae162fbc86..c22f12fad4 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@

-This project comes as a pre-built docker image that enables you to easily forward to your websites +This project comes as a pre-built Docker image that enables you to easily forward to your websites running at home or otherwise, including free SSL, without having to know too much about Nginx or Letsencrypt. - [Quick Setup](#quick-setup) @@ -20,9 +20,9 @@ running at home or otherwise, including free SSL, without having to know too muc ## Project Goal I created this project to fill a personal need to provide users with an easy way to accomplish reverse -proxying hosts with SSL termination and it had to be so easy that a monkey could do it. This goal hasn't changed. -While there might be advanced options they are optional and the project should be as simple as possible -so that the barrier for entry here is low. +proxying hosts with SSL termination, and it had to be so easy that a monkey could do it. This goal hasn't changed. +While there might be advanced options, they are optional, and the project should be as simple as possible +so that the barrier to entry here is low. Buy Me A Coffee @@ -30,11 +30,11 @@ so that the barrier for entry here is low. ## Features - Beautiful and Secure Admin Interface based on [Tabler](https://tabler.github.io/) -- Easily create forwarding domains, redirections, streams and 404 hosts without knowing anything about Nginx +- Easily create forwarding domains, redirections, streams, and 404 hosts without knowing anything about Nginx - Free SSL using Let's Encrypt or provide your own custom SSL certificates - Access Lists and basic HTTP Authentication for your hosts - Advanced Nginx configuration available for super users -- User management, permissions and audit log +- User management, permissions, and audit log ::: warning `armv7` is no longer supported in version 2.14+. This is due to Nodejs dropping support for armhf. Please @@ -43,15 +43,15 @@ use the `2.13.7` image tag if this applies to you. ## Hosting your home network -I won't go in to too much detail here but here are the basics for someone new to this self-hosted world. +I won't go into too much detail here, but here are the basics for someone new to this self-hosted world. 1. Your home router will have a Port Forwarding section somewhere. Log in and find it -2. Add port forwarding for port 80 and 443 to the server hosting this project +2. Add port forwarding for ports 80 and 443 to the server hosting this project 3. Configure your domain name details to point to your home, either with a static ip or a service like - DuckDNS - [Amazon Route53](https://github.com/jc21/route53-ddns) - [Cloudflare](https://github.com/jc21/cloudflare-ddns) -4. Use the Nginx Proxy Manager as your gateway to forward to your other web based services +4. Use the Nginx Proxy Manager as your gateway to forward to your other web-based services ## Quick Setup