index.gmi

   1 # gemini.koplugin: Gemini client for KOReader
   2 A Gemini client aimed at internet-enabled touch-screen e-book reader devices, implemented as a plugin for KOReader.
   3 => https://koreader.rocks/ KOReader site
   4
   5 # Installing / updating
   6 * Update KOReader if necessary -- versions 2023.03 and later should be supported.
   7 * Download the tarball or git repository below, and extract to the plugins/ directory within your koreader directory (e.g. /.adds/koreader/plugins/), such that the directory plugins/gemini.koplugin/ exists.
   8 => gemini.koplugin.tgz tarball
   9 => git://thegonz.net/gemini.koplugin/ git clone git://thegonz.net/gemini.koplugin/
  10 => gemini.koplugin.bundle git bundle
  11
  12 Restart KOReader, and select "Browse Gemini" from the search menu to get started.
  13
  14 # Features
  15 * File viewing via KOReader, so many filetypes supported.
  16 * Bookmarks, history, and queue, with caching for offline use.
  17 * Trust-On-First-Use verification of server identities.
  18 * Use and generation of user identities (client certificates).
  19 * Configurable navigation gestures.
  20
  21 => screenshot.png Screenshot
  22
  23 # Limitations
  24 * Resuming TLS sessions not supported; full handshake performed on each connection.
  25 * Displaying files during download ("streaming") not supported.
  26 * CA-based certificate verification not supported; user prompted each time the tail certificate changes.
  27
  28 => TODO.gmi Further TODOs
  29
  30 # Compatibility
  31 Tested on Kobo Glo HD with KOReader versions >= 2023.03. May be difficult to use on non-touch devices; feedback on this welcome.
  32
  33 # Licence
  34 You may distribute this plugin under the terms of the GPL, version 3 or later.
  35 => COPYING GPLv3
  36
  37 # Feedback
  38 Please write to <mbays@sdf.org> with any bug reports, feature requests, etc.