Skip to content

Commit

Permalink
Fix and polish README
Browse files Browse the repository at this point in the history
  • Loading branch information
cyrus-and committed Sep 30, 2023
1 parent c4b72d3 commit 4db23f6
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ It consists of:

![Screenshot](https://i.imgur.com/kcmq8PA.png)

## Installation
## Setup

Install the PHP extension, either by using the [deploy script](#deploy-script) or [manually](#manual-setup). Then install the listener application [locally](#installation).
Install the PHP extension, either by using the [deploy script](#deploy-script) or [manually](#manual-setup), then install the listener application [locally](#installation).

## Demo

Expand Down Expand Up @@ -127,7 +127,7 @@ Finally, install the PHP extension in the usual way, briefly:

At this point the source repository is no more needed, you can run `make cleanall` to clean everything up.

#### Settings
### Settings

The default INI settings should work just fine in most cases. The following serves as a template for some common ways to override the default values:

Expand Down Expand Up @@ -174,9 +174,7 @@ $ npm uninstall -g fracker

Run `fracker --help` to obtain the full usage.

Command line options in long format can be written in YAML files (camel case and without the leading `--`) and passed as command line arguments. Multiple files with increasing priority can be specified, but command line options will have the highest priority.

For convenience some [configuration files](app/configs/) listing some classes of *interesting* PHP functions are provided along with this repo. Use them like:
For convenience some [configuration files](app/configs/) listing some classes of *interesting* PHP functions are provided along with this repository. Use them like:

```console
$ fracker ./app/configs/file-* # ...
Expand Down

0 comments on commit 4db23f6

Please sign in to comment.