docs: update README with modern architecture and docker instructions

Author: TinyProxy Dev

README.md

@@ -1,71 +1,94 @@
 # TinyProxy
 
-tinyproxy is a lightweight PHP proxy service with caching for fetching and serving web resources.
+TinyProxy is a fast, secure, and modern PHP proxy service with advanced caching, SSRF protection, rate limiting, and a sleek web UI.
 
-screenshots:
-![Screenshot 2023-09-03 00 00 25](https://github.com/bethropolis/tinyproxy/assets/66518866/7acd4764-25a7-407e-967e-d193d8165672)
-
-![Screenshot 2023-09-03 00 06 26](https://github.com/bethropolis/tinyproxy/assets/66518866/1fef1996-e96e-41f1-95dd-7f7eae89ce1c)
+## Features
 
+- **High-performance caching:** File-based caching with automatic GZIP compression.
+- **Enterprise Security:** Built-in SSRF prevention, private IP blocking, and request rate limiting.
+- **Smart Modifications:** Automatic URL rewriting, ad blocking, and asset transformations on the fly.
+- **Admin Dashboard:** Built-in statistics, metrics, and cache management interface.
+- **Docker Ready:** Easy deployment using Docker and Docker Compose.
 
 ## Installation
 
-1. Clone this repository to your web server:
+### Using Docker (Recommended)
 
+1. Clone this repository:
 ```sh
 git clone https://github.com/bethropolis/tinyproxy.git
-
 cd tinyproxy
 ```
 
-2. Install the required dependencies using Composer:
+2. Start the service using Docker Compose:
+```sh
+docker-compose up -d --build
+```
+Your proxy will be available at `http://localhost:8080`.
+
+### Manual Installation (PHP 8.3+)
 
+1. Clone this repository:
+```sh
+git clone https://github.com/bethropolis/tinyproxy.git
+cd tinyproxy
 ```
+
+2. Install dependencies using Composer:
+```sh
 composer install
 ```
-3. Run the TinyProxy service:
-```
-php -S localhost:8080
-```
-> I recommend using an `apache` server or `nginx` server.
 
-using docker:
-```
-docker build -t tinyproxy .
-docker run -p 8080:80 --name tinyproxy-container tinyproxy
+3. Run the TinyProxy development server:
+```sh
+php -S localhost:8080 -t public
 ```
 
+> For production, it's recommended to point an Apache or Nginx virtual host directly to the `public/` directory.
+
 ## Usage
 
-To use TinyProxy, simply make requests to the proxy URL with the `url` parameter:
+To use TinyProxy, simply visit the homepage or make requests to the proxy URL with the `url` parameter:
 
 ```
 http://localhost:8080/?url=https://www.example.com
 ```
-curl:
+
+Via cURL:
 ```bash
-$ curl http://localhost:8080/?url=https://www.example.com
+$ curl "http://localhost:8080/?url=https://www.example.com"
 ```
-> replace `localhost:8080` with  your web server's address.
 
-#### parameters
+### Admin Dashboard
 
-| parameter | description   | type  |
-| --------- | ------------- |-------|
-| `url` | The URL to proxy. |string |
-| `cache` | The cache directory. |bool|
+You can monitor proxy performance, view statistics, and clear the cache by visiting the admin dashboard:
+```
+http://localhost:8080/admin
+```
+
+### Configuration
 
+TinyProxy uses a dot-notation configuration system. You can easily customize the application by creating a `.env` file in the project root:
 
-> for more customization edit the `config.php` file.
+```env
+APP_ENV=production
+APP_DEBUG=false
 
+# Cache settings
+CACHE_ENABLED=true
+CACHE_DEFAULT_TTL=3600
+
+# Security
+SECURITY_BLOCK_PRIVATE_IPS=true
+SECURITY_RATE_LIMIT_ENABLED=true
+```
 
 ## Contributing
 
-Contributions are welcome! If you find a bug or have an enhancement idea, please open an issue or submit a pull request.
+Contributions are welcome! If you find a bug or have an enhancement idea, please open an issue or submit a pull request. Ensure tests pass by running `vendor/bin/phpunit` before submitting.
 
 ## License
 
 TinyProxy is released under the MIT License. See [LICENSE](LICENSE) for details.
 
-
-Happy proxying! 💜
+Happy proxying!