From 3cc1a8e587655b71d306db499a6ce32543a256dc Mon Sep 17 00:00:00 2001
From: Antti Jaakkola <antti.jaakkola@remod.fi>
Date: Tue, 26 Nov 2024 14:37:01 +0200
Subject: [PATCH] Update README

---
 README.md | 33 +++++++++++++++++++++++----------
 1 file changed, 23 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 62aee34..38bd890 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ Installation
 
 * Install python 3.
 * Copy ngflush.ini.sample to /etc/ngflush.ini
-* Edit /etc/ngflush.ini, fix cache_path and cache_levels if needed.
+* Edit /etc/ngflush.ini, fix `cache_path` and `cache_levels` if needed.
 * Enable systemd service
 
 ```shell
@@ -21,7 +21,7 @@ systemctl start ngflush.service
 
 ```
 
-* Configure Nginx, replace CACHE_KEY with proxy_cache_key value, NORMAL_BACKEND with your backend name and CACHE_NAME with cache name.
+* Configure Nginx, replace `CACHE_KEY` with `proxy_cache_key` value, `NORMAL_BACKEND` with your backend name and `CACHE_NAME` with cache name.
 
 ```nginx
 
@@ -59,6 +59,7 @@ location / {
 
   ...
 
+  proxy_pass http://$proxy_target;
   proxy_cache $use_cache;  # Prevent caching responses from ngflush.
 
   ...
@@ -70,6 +71,7 @@ location / {
 ```
 
 * Restart nginx
+
 ```shell
 nginx -t && nginx -s reload
 ```
@@ -84,11 +86,22 @@ Usage
 License
 =======
 
-The MIT License (MIT)
-Copyright (c) 2016, Remod Oy
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\ No newline at end of file
+The MIT License (MIT) Copyright (c) 2016-2024, Remod Oy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.