From adb08cbdf34fdd2c53e2950a47731f379b65c592 Mon Sep 17 00:00:00 2001
From: Elizabeth Cray <liz@cray.software>
Date: Fri, 31 Jan 2025 23:38:20 -0500
Subject: [PATCH] Users are friends so I'll tell them things

---
 README.md   | 15 ++++++++++++++-
 example.env |  4 ++--
 2 files changed, 16 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index ea67d91..1e1ae39 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,14 @@
-# M2B - Mastodon ➡️ Bluesky crossposter
\ No newline at end of file
+# M2B - Mastodon ➡️ Bluesky crossposter
+
+FYI: This is a work-in-progress and I intend to clean up the code and make this *MUCH* more user-friendly.
+
+## Why did I make this?
+
+I was having a hard time finding a mastodon --> bluesky crossposting tool that supported replies and boosts on top of normal posts. This ended up wasting enough time to where I figured I'd just make my own.
+
+## How to use
+
+Don't forget to install dependencies with `npm i` and adjust the config by copying `example.env` into `.env`.
+Get the mastodon credentials from going to user preferences > development > and creating a new application.
+For bluesky credentials you have to make a new app password under settings > privacy and security > app passwords.
+This should ideally be run from a cron job (specifically `run.sh`), but can be run with just `node index.js`.
diff --git a/example.env b/example.env
index 427744b..5e26a6f 100644
--- a/example.env
+++ b/example.env
@@ -1,6 +1,6 @@
 MASTODON_TOKEN: ""
 MASTODON_INSTANCE: "https://mastodon.social"
-MASTODON_USER: ""
+MASTODON_USER: "alice"
 BSKY_INSTANCE: "https://bsky.social"
-BSKY_USER: "username.bsky.social"
+BSKY_USER: "alice.bsky.social"
 BSKY_APP_PASS: ""
\ No newline at end of file