GithubHelp home page GithubHelp logo

mikelittle / mastobot Goto Github PK

View Code? Open in Web Editor NEW

This project forked from nicolevanderhoeven/mastobot

0.0 1.0 0.0 5.98 MB

Mastodon bot for sending Mastodon toots to Readwise

License: Apache License 2.0

JavaScript 100.00%

mastobot's Introduction

mastobot

Mastodon bot for sending Mastodon posts to Readwise. Check out my blog post for more details.

Pre-requisites

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.
  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 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

Mastodon posts after import into Obsidian

Screenshot of a Mastodon post imported into Obsidian

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.