README.md
changeset 25717 b6fa5201d082
parent 25711 2bb339143f01
--- a/README.md
+++ b/README.md
@@ -1,39 +1,44 @@
 # Exceptionrules
 
-This is a project which contains filter rules in order for Acceptable Ads program to work
+This project contains filter rules for the Acceptable Ads program.
+
+***IMPORTANT:*** After cloning the project, follow the installation steps in order for the pre-commit hook to work.
+
 
-***IMPORTANT:*** After cloning the project, you need to run the following command in order to add the pre-commit hook:
+## Installation
+
+### Windows
 
-## Windows
-Windows: turn on Developer Mode is settings->system->for developers and run 
+1. Turn on Developer Mode in `Settings -> System -> For developers`.
+2. Run the following commands in order to set up the linux subsystem environment and create a symbolic link for the pre-commit hook:
+
 ```sh
 export MSYS=winsymlinks:nativestrict
-```
-
-```sh
 wsl --update
+wsl --install -d Ubuntu-24.04
+wsl -s Ubuntu-24.04
+wsl sudo apt update
+wsl sudo apt install jq
+ln -s -f "$(pwd)/pre-commit-src/pre-commit" "$(pwd)/.git/hooks/pre-commit"
 ```
 
-```sh
-wsl --install -d Ubuntu-24.04
-```
+### macOS
+
+The script requires a newer version of bash, which is not the default on macOS. Install it using Homebrew and create a symbolic link for the pre-commit hook::
 
 ```sh
- wsl -s Ubuntu-24.04
+brew install bash
+ln -s -f "$(pwd)/pre-commit-src/pre-commit" "$(pwd)/.git/hooks/pre-commit"
 ```
 
-```sh
-wsl sudo apt update
-```
+### Linux
 
-```sh
-wsl sudo apt install jq 
-```
+Everything should work out of the box. Create a symbolic link for the pre-commit hook:
 
 ```sh
 ln -s -f "$(pwd)/pre-commit-src/pre-commit" "$(pwd)/.git/hooks/pre-commit"
 ```
 
-When you add files/change their names remember to add it to template files and inform AFB team.
+## Adding New Domain Variables Files
 
-MAC update bash `brew install bash`
+When adding or renaming files, remember to update the template files and inform the team responsible for delivering the filterlist.