README.md

   1 # DerStandard Terminal Liveticker
   2
   3 https://gir.st/dst-live.htm
   4
   5 ## Usage
   6
   7     ./ticker <dst.at-URL> [backlog-#] | ./format [img=1] [noembed=1] [wdiff=1]
   8
   9 Supply a `derstandard.at/jetzt/livebericht/2000xxxxxxxxx/...` url (or just the
  10 2000xxxxxxxxx ID) to `ticker`. By default, the whole available backlog will be
  11 immediately downloaded; you can limit backlog to any number of items by
  12 supplying an integer as the second argument (caveat: the API will still return
  13 all items marked as important (yellow bar in the website) on top of the number
  14 of requested items).
  15 Supply a truthy value for `img` to `format` to display images in-line using
  16 Unicode half-blocks, or supply a truthy value to `noembed` to disable
  17 inline-tweets and selected user comments. The default is to show textual
  18 content inline, and embedded media as a URL. To enable word wise diffing of
  19 updates, supply wdiff with a truthy value.
  20
  21 *Example*: `./ticker 2000103942403 0 | ./format`
  22
  23 Please be aware that this project is not endorsed by or affiliated with
  24 derStandard.at and may or may not be in compliance with their terms of
  25 service--use at your own risk.
  26
  27 ## Requirements
  28
  29  * curl
  30  * awk
  31  * fold (GNU coreutils)
  32  * [jq]
  33  * [websocat]
  34  * [viu] if you want inline-images
  35  * [wdiff] if you want diffed updates to posts
  36
  37 [jq]: https://github.com/stedolan/jq
  38 [websocat]: https://github.com/vi/websocat
  39 [viu]: https://github.com/atanunq/viu
  40 [wdiff]: https://www.gnu.org/software/wdiff/
  41
  42 The `$PATH` has been adjusted within the scripts to also look in the current
  43 directory for these uncommon binaries.
  44
  45 ## License
  46
  47 Copyright (c) 2019 Tobias Girstmair (https://gir.st/)
  48 You can study, share and improve this software under the terms of the GNU
  49 General Public License, version 3 (see: `LICENSE`).