AnthoLume/client/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.
[add] rename to AnthoLume 2023-11-04 23:40:32 +00:00			`# AnthoLume - SyncNinja KOReader Plugin`
[add] split wanted files vs wanted metadata for ko apis, [add] documentation 2023-09-19 23:29:55 +00:00
[add] rename to AnthoLume 2023-11-04 23:40:32 +00:00			This is AnthoLume's KOReader Plugin called `syncninja.koplugin`. Features include:
[add] split wanted files vs wanted metadata for ko apis, [add] documentation 2023-09-19 23:29:55 +00:00
[add] settings (pw & time offset), [fix] PWA issues, [fix] misc styling issues 2023-09-27 22:58:47 +00:00			`- Syncing read activity`
			`- Uploading documents`
			`- Configurable sync settings`

			`## Installation`
[add] split wanted files vs wanted metadata for ko apis, [add] documentation 2023-09-19 23:29:55 +00:00
			Copy the `syncninja.koplugin` directory to the `plugins` directory for your KOReader installation. Restart KOReader and SyncNinja will be accessible via the Tools menu.

[add] settings (pw & time offset), [fix] PWA issues, [fix] misc styling issues 2023-09-27 22:58:47 +00:00			`## Configuration`
[add] split wanted files vs wanted metadata for ko apis, [add] documentation 2023-09-19 23:29:55 +00:00
[add] rename to AnthoLume 2023-11-04 23:40:32 +00:00			`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.`
[add] split wanted files vs wanted metadata for ko apis, [add] documentation 2023-09-19 23:29:55 +00:00
[add] settings (pw & time offset), [fix] PWA issues, [fix] misc styling issues 2023-09-27 22:58:47 +00:00			`## KOSync Compatibility`
[add] split wanted files vs wanted metadata for ko apis, [add] documentation 2023-09-19 23:29:55 +00:00
[add] rename to AnthoLume 2023-11-04 23:40:32 +00:00			`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.`
[add] settings (pw & time offset), [fix] PWA issues, [fix] misc styling issues 2023-09-27 22:58:47 +00:00
			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.