README.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
   4 # Installing / updating
   5 * Update KOReader if necessary -- versions 2023.03 and later should be supported.
   6 * Extract to the plugins/ directory within your koreader directory (e.g. /.adds/koreader/plugins/), such that plugins/gemini.koplugin/ contains the *.lua files.
   7 * Restart KOReader, and select "Browse Gemini" from the search menu to get started.
   8
   9 # Features
  10 * File viewing via KOReader, so many filetypes supported.
  11 * Bookmarks, history, and queue, with caching for offline use.
  12 * Trust-On-First-Use verification of server identities.
  13 * Use and generation of user identities (client certificates).
  14 * Configurable navigation gestures.
  15
  16 # Limitations
  17 * Resuming TLS sessions not supported; full handshake performed on each connection.
  18 * Displaying files during download ("streaming") not supported.
  19 * CA-based certificate verification not supported; user prompted each time the tail certificate changes.
  20
  21 # Compatibility
  22 Tested on Kobo Glo HD with KOReader versions >= 2023.03. May be difficult to use on non-touch devices; feedback on this welcome. Tested as not working on Android, for reasons unknown.
  23
  24 # Licence
  25 You may distribute this plugin under the terms of the GPL, version 3 or later.
  26
  27 # Feedback
  28 Please write to <mbays@sdf.org> with any bug reports, feature requests, patches, etc.