From aac28584998c4b12ad9c316ec41aa8c10390eef3 Mon Sep 17 00:00:00 2001
From: Hykilpikonna <me@hydev.org>
Date: Tue, 20 Dec 2022 00:53:40 -0500
Subject: [PATCH] [U] Update readme

---
 README.md | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 344ca9e8e..2636658f8 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,21 @@
 # blog-data
-Telegram API data for my blog
+
+Syncronized telegram channel data for my blog, created using my [TelegramBackup](https://github.com/one-among-us/TelegramBackup) project.
+
+## Usage
+
+1. Fork this repo
+2. Change the channel ID in /src/github_actions.py
+3. Run GitHub actions
+4. Go to GitHub Pages settings and enable it, select `gh-pages` branch.
+5. Your channel json will be hosted at `https://<username>.github.io/TelegramChanApi/posts.json`
+
+(The GitHub actions script will update the JSON once every two hours)
+
+## Example
+
+https://profile-api.hydev.org/posts.json
+
+# Zotero API Localization
+
+Additionally, this repo can be used to localize your Zotero publications. Just go to Settings > Secrets and put your Zotero user id into a secret named ZOTERO_USERID.