README.md

   1 # DerStandard Terminal Liveticker
   2
   3 https://gir.st/dst-live.htm
   4
   5 ## Usage
   6
   7     ./dst-live [--noembed] [--noimg] [--nodiff] <dst.at-URL> [backlog-#]
   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 If `viu` is available (and `--noimg` isn't supplied), images will be displayed
  16 in-line using Unicode half-blocks. Tweets will be inlined unless `--noembed` is
  17 provided. Otherwise, the URL of the embedded content is printed below the posts.
  18 Word wise diffing (needs wdiff) of updates can be disabled by supplying
  19 `--nodiff`.
  20
  21 Please be aware that this project is not endorsed by or affiliated with
  22 derStandard.at and may or may not be in compliance with their terms of
  23 service--use at your own risk.
  24
  25 ## Requirements
  26
  27  * curl
  28  * awk
  29  * fold (GNU coreutils)
  30  * [jq]
  31  * [websocat]
  32  * [viu] if you want inline-images
  33  * [wdiff] if you want diffed updates to posts
  34
  35 [jq]: https://github.com/stedolan/jq
  36 [websocat]: https://github.com/vi/websocat
  37 [viu]: https://github.com/atanunq/viu
  38 [wdiff]: https://www.gnu.org/software/wdiff/
  39
  40 The `$PATH` has been adjusted within the scripts to also look in the current
  41 directory for these uncommon binaries.
  42
  43 ## License
  44
  45 Copyright (c) 2019 Tobias Girstmair (https://gir.st/)
  46 You can study, share and improve this software under the terms of the GNU
  47 General Public License, version 3 (see: `LICENSE`).