document example usage

[alexanderankin]

for example, you can start a broker, start pg honey and listen to it:

# pip install hpfeeds[broker]
# https://github.com/hpfeeds/hpfeeds
HPFEEDS_ABC123_SECRET=def567 \
HPFEEDS_ABC123_PUBCHANS=pghoney.events \
HPFEEDS_ABC123_SUBCHANS=pghoney.events \
hpfeeds-broker --auth env --endpoint tcp:port=10000

# in a new terminal
git clone git@github.com:betheroot/pghoney.git && cd pghoney
go mod init github.com/betheroot/pghoney
grep -nr Siru | awk -F: ' { print $1 } ' | xargs -n1 sed -i 's#github.com/Sirupsen/logrus#github.com/sirupsen/logrus#'
go mod tidy
go build
cp pghoney.conf{.sample,}
./pghoney

# in a new terminal
nc localhost 5432