Unofficial Paperbnd/Popfeed plugin for KOReader
1# paperbnd.koplugin
2
3A [KOReader] plugin for syncing your reading progress to [Paperbnd]/[Popfeed].
4
5This plugin associates a document in KOReader with a
6`social.popfeed.feed.listItem` record in your Atproto PDS, and then enables
7you to update that record with your reading progress at automatically or at the press of a button.
8
9Some limitations:
10
11- [ ] Books must be added to your account from the Paperbnd website or Popfeed website/app before they can be linked
12- [ ] Books must already be in a `currently_reading_books` list
13
14## Installation
15
161. Download/clone this repository
172. Drag the `paperbnd.koplugin` folder into your KOReader plugins directory
183. Restart KOReader
19
20## Usage
21
221. Create an App Password wherever your Atproto account is managed (Bluesky, Tangled, elsewhere)
232. Open the KOReader menu
243. Navigate to the second page of the first tab
254. Select the "Paperbnd" option
265. Select "Set credentials"
276. Enter your Handle and App Password when prompted
287. Select "Link current book"
298. Select your book from the list
309. From the Paperbnd menu, select "Sync progress now"
31
32[Paperbnd]: https://paperbnd.club/
33[Popfeed]: https://popfeed.social/
34[KOReader]: https://koreader.rocks/