Skip to content

Commit 91447b5

Browse files
committed
Update README.md for more information.
1 parent b8ab22e commit 91447b5

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# nginx-naxsi-pagespeed
22

3-
This script automates installation, compilation of nginx, naxsi, and ngx_pagespeed. In addition, it allows you to update nginx, naxsi, and ngx_pagespeed just by changing the variables' version.
3+
This script is intended to automate installation & compilation of nginx, naxsi, and ngx_pagespeed. In addition, it allows you to update nginx, naxsi, and ngx_pagespeed just by changing the variables' version. Usually, the packages' versions listed on the script are up to date. However, it may be good practice to check to ensure that you get the lastest version installed.
44

55
# Documentation
66

7-
All you have to do is edit the following.
7+
Before running the script in bash or shell, ensure to change the variables. In addition, it is great practice to skim through the script before running the script.
88

9-
DIRECTORY=(add path to directory where you want temporary installation files to be stored)
9+
DIRECTORY=(This is the directory where it will use to download the packages and compile them)
1010

1111
PAGESPEED=(pagespeed version goes here. Obtain one from https://github.com/pagespeed/ngx_pagespeed/releases)
1212

@@ -17,9 +17,9 @@ COMPILE=(arguments that are used to compile NGINX goes here. Ensure that you mod
1717

1818
If you want to skip a process, (ex: skip installation of dependencies, or skip installation of naxsi), simply comment out the call of function in the bottom of the script.
1919

20-
To upgrade, simply change the versions of variables of the outdated packages in the variables. It will automatically compare the version, and update the packages into latest version.
20+
To upgrade any packages installed, simply change the versions of variables of the outdated packages in the variables. It will automatically compare the version installed (directory name in the cache), and update the packages into latest version.
2121

22-
To run this script, simply type following.
22+
To run this script, simply type the following into bash or shell.
2323

2424
chmod +x nnp.sh && bash nnp.sh
2525

0 commit comments

Comments
 (0)