History

Evan Reichard 5e388730a5 formatting: lua plugin		2024-12-01 11:28:33 -05:00
..
syncninja.koplugin	formatting: lua plugin	2024-12-01 11:28:33 -05:00
README.md	[add] rename to AnthoLume	2023-11-04 19:55:38 -04:00

README.md

AnthoLume - SyncNinja KOReader Plugin

This is AnthoLume's KOReader Plugin called syncninja.koplugin. Features include:

Syncing read activity
Uploading documents
Configurable sync settings

Installation

Copy the syncninja.koplugin directory to the plugins directory for your KOReader installation. Restart KOReader and SyncNinja will be accessible via the Tools menu.

Configuration

You must configure the AnthoLume server and credentials in SyncNinja. Afterwhich you'll have the ability to configure the sync cadence as well as whether you'd like the plugin to sync your activity, document metadata, and/or documents themselves.

KOSync Compatibility

AnthoLume implements API's compatible with the KOSync plugin. This means that you can utilize this server for KOSync (and it's recommended!). SyncNinja provides an easy way to merge configurations between both KOSync and itself in the menu.

The KOSync compatible API endpoint is located at: http(s)://<SERVER>/api/ko. You can either use the previous mentioned merge feature to automatically configure KOSync once SyncNinja is configured, or you can manually set KOSync's server to the above.