https://github.com/nicolevanderhoeven/mastobot

Mastodon bot for sending Mastodon toots to Readwise
https://github.com/nicolevanderhoeven/mastobot

Last synced: 2 months ago
JSON representation

Mastodon bot for sending Mastodon toots to Readwise

• Host: GitHub
• URL: https://github.com/nicolevanderhoeven/mastobot
• Owner: nicolevanderhoeven
• License: apache-2.0
• Created: 2022-12-24T16:45:12.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-31T01:57:03.000Z (about 2 years ago)
• Last Synced: 2024-08-03T22:14:41.304Z (5 months ago)
• Language: JavaScript
• Size: 5.84 MB
• Stars: 12
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-readwise - mastobot - A Mastodon bot for sending toots to Readwise. (Tools / Mastodon)

README

        
# mastobot

Mastodon bot for sending Mastodon posts to Readwise. Check out [my blog post](https://nicolevanderhoeven.com/blog/20221225-mastodon-bot-for-readwise-and-obsidian/) for more details.

## Pre-requisites

- A Mastodon account (I use and co-host [pkm.social](https://pkm.social) for free)

- A Readwise account ([Here's an affiliate link](https://readwise.io/nicole))

- Familiarity with GitHub, the command line, Node.js

## Usage

1. Clone this repository.

2. In your Mastodon account settings, go to the Development section for your Mastodon server (e.g. `https://pkm.social/settings/applications`) and click New Application.

3. Fill in the application name (this can be anything you want), leave everything else the same, and then click Save Changes.

4. Click on the application you just created, and note your client key, client secret, and access token. You'll need these later.

5. In this repository, copy the contents of `.env.sample` to a new file called `.env`.

6. Fill out the fields in `.env` with the information you just obtained from your Mastodon account.

7. For the `READWISE_TOKEN` field, enter your [Readwise access token](https://readwise.io/access_token).

8. For the `DOMAIN` field, enter your Mastodon server's domain (e.g. `https://pkm.social`).

9. Run `npm install` to install the dependencies.

10. Run `node bot.js` to start the bot.

11. In Mastodon, find a post you like and reply to it with `@botname Your comment here.` Within a few minutes, the original post you replied to will be sent to your Readwise account as a highlight and your comment as a note.

(Optional) If you use [Obsidian](https://obsidian.md) and you have the Readwise Official plugin installed and automatically syncing, the Mastodon posts you've replied to will show up in your Obsidian vault!

## Screenshots

### Mastodon posts on the Readwise Dashboard

![Screenshot of Mastodon posts from the Readwise Dashboard](assets/mastodon-on-readwise.png)

### Mastodon posts after import into Obsidian

![Screenshot of a Mastodon post imported into Obsidian](assets/mastodon-in-obsidian.png)

(Note: The exact formatting of the post will depend on your Readwise settings.)