From b815d1f7803abb4274b5f4f800cb56cf2f13bbe2 Mon Sep 17 00:00:00 2001
From: astravexton <astra@zio.sh>
Date: Sun, 8 Jun 2025 14:06:01 +0100
Subject: [PATCH] add README.md

---
 README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fe4b0d7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+bsky2tg
+=======
+
+**bsky2tg** will mirror posts from your Bluesky account to a Telegram channel through a bot. It supports creation and deletion of posts on Bluesky but not the other way.
+
+---
+
+### Usage
+
+Create a .env file with the following:
+
+```properties
+TG_TOKEN=
+TG_CHANNEL_ID=
+BSKY_HANDLE=
+BSKY_PASSWORD=
+```
+
+To run:
+
+```bash
+podman run -it --name bsky2tg_<profile> \
+  --env-file /path/to/.env \
+  git.zio.sh/astra/bsky2tg:latest
+```
+
+Or without `.env` file:
+
+```bash
+podman run -it --name bsky2tg_<profile> \
+  --env TG_TOKEN= \
+  --env TG_CHANNEL_ID= \
+  --env BSKY_HANDLE= \
+  --env BSKY_PASSWORD= \
+  git.zio.sh/astra/bsky2tg:latest
+```