Skip to content

Commit 714e531

Browse files
committed
Content improve
1 parent 30ddc32 commit 714e531

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,15 @@ As a dynamic library, don’t forget that libmodsecurity must be installed to a
5757

5858
### Unix (Linux, MacOS, FreeBSD, …)
5959

60-
On unix the project uses autotools to help the compilation process. Please note that if you work with `git`, do not forget to initialize submodules and update them. Here is a brief howto:
60+
On unix the project uses autotools to help the compilation process. Please note that if you are working with `git`, don't forget to initialize and update the submodules. Here's a quick how-to:
6161
```shell
6262
$ git clone https://github.com/owasp-modsecurity/ModSecurity ModSecurity
6363
$ cd ModSecurity
6464
$ git submodule init
6565
$ git submodule update
6666
```
6767

68-
After that, you can start the build process:
68+
You can then start the build process:
6969

7070
```shell
7171
$ ./build.sh
@@ -245,7 +245,9 @@ $ sudo make install
245245

246246
### Benchmarking
247247

248-
The source tree has a Benchmark tool which can help to measure the library's performance. The tool is under the `test/benchmark/` directory. The build process also makes the binary here, so after the end of compiling you will have the tool.
248+
The source tree includes a Benchmark tool that can help measure library performance. The tool is located in the test/benchmark/ directory. The build process also creates the binary here, so you will have the tool after the compilation is finished.
249+
250+
The source tree includes a Benchmark tool that can help measure library performance. The tool is located in the `test/benchmark/` directory. The build process also creates the binary here, so you will have the tool after the compilation is finished.
249251

250252
To run, just type:
251253

@@ -273,7 +275,7 @@ user 0m0.337s
273275
sys 0m0.022s
274276
```
275277

276-
This is very fast because the benchmark uses the minimal `modsecurity.conf.default` configuration, which has not so much rules:
278+
This is very fast because the benchmark uses the minimal `modsecurity.conf.default` configuration, which doesn't not too much rules:
277279

278280
```shell
279281
$ cat basic_rules.conf
@@ -282,7 +284,7 @@ Include "../../modsecurity.conf-recommended"
282284

283285
```
284286

285-
To measure it with real rules, you should run one of the download scripts in the same directory:
287+
To measure with real rules, run one of the download scripts in the same directory:
286288

287289
```shell
288290
$ ./download-owasp-v3-rules.sh
@@ -309,13 +311,13 @@ Now the command will give much higher value.
309311

310312
#### How the benchark works
311313

312-
The tool is a simple embedding application which uses the library. It creates a ModSecurity and a RuleSet instance, then runs a loop with number of you passed. Creates a Transaction (object) and emulates real HTTP transactions.
314+
The tool is a simple wrapper application that uses the library. Creates a ModSecurity instance and a RuleSet instance, then runs a loop with the passed number. Creates a Transaction (object) and emulates real HTTP transactions.
313315

314-
A transaction is a HTTP/1.1 GET request with a few GET parameters. Added common headers then the response: headers and an XML body. Between the phases it checks did any intervention happen or not. Every transaction is created with same data.
316+
The transaction is an HTTP/1.1 GET request with some GET parameters. Added common headers then the response: headers and an XML body. Between phases it checks whether an intervention has taken place or not. All transactions are created with same data.
315317

316-
Note, that the tool does not call the last phase (logging).
318+
Note that the tool does not call the last phase (logging).
317319

318-
Please don't forget to reset the `basic_rules.conf` content if you want to try it with another rule set.
320+
Please remember to reset `basic_rules.conf` if you want to try with a different ruleset.
319321

320322
## Reporting Issues
321323

0 commit comments

Comments
 (0)