From 6dab423eef3ecd3a639b0198fe3dd467eea7f379 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Ho=CC=88gborg?= Date: Thu, 22 Oct 2015 23:04:22 +0200 Subject: [PATCH] Updated readme with usage examples --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0f67ea2..252f903 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,18 @@ # go-pocsag -A parser for POCSAG pager protocol implemented in Go \ No newline at end of file +A parser for POCSAG pager protocol implemented in Go + +## Usage +Read a recorded wav file `gopocsag -i path/to/file.wav` + +Listen to stream from rtl_fm: `rtl_fm -f -E deemp | gopocsag` + +Parse a raw datadump: `cat dump.bin | gopocsag` + +## Options +* `--type` force message parsing type, one of `auto` `bcd` `alpha` +* `--debug` print debugging and extra information about transmission. +* `--verbosity` regulate the detail of debugging information + +## Resource usage +Not much. About 0.2% of a i5 during normal operations. Just above 5 mb of RAM. \ No newline at end of file