diff options
Diffstat (limited to '')
-rw-r--r-- | Readme.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..a34e921 --- /dev/null +++ b/Readme.md @@ -0,0 +1,35 @@ +# human-readable gtfs realtime feeds + +a tool to answer to the question "how to check that the gtfs realtime feed says +what it's supposed to if for some unfortunate reason you can't read binary?". + +At 188 crates, it might be suspected that it gives a *slightly* over-engineered +answer. + +~~~ +Usage: showrt [OPTIONS] <URL> + +Arguments: + <URL> uri of the GTFS RT feed to fetch & display + +Options: + --json emit the feed as json + -i, --ignore-nonfatal ignore things that look wrong as long as possible + --no-colors don't do terminal colours + -h, --help Print help information + -V, --version Print version information +~~~ + +### Features: + - fetch feeds from some url + - display feeds in protobuf pseudo-format, optionally with fancy colours + - dump the entire feed as json to process it with `jq` & friends + - error messages with entirely too many arrows in them + +### Still Todo: + - open local files (why do people even have these?) + - play nice with (input-)pipes + - optionally convert all dates into something more human-friendly than seconds + since the unix epoch + - optionally collapse translations that contain only one language in the output + |