From c5d0fa1fb08e3a3d4dca7aaff7590d35072f0e75 Mon Sep 17 00:00:00 2001
From: clarkzjw <i@jinwei.me>
Date: Thu, 23 Feb 2023 11:16:27 -0800
Subject: update README

---
 README                  | 15 ---------------
 README.md               | 27 +++++++++++++++++++++++++++
 dbstore/peewee_store.py |  2 ++
 3 files changed, 29 insertions(+), 15 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index b42b771..0000000
--- a/README
+++ /dev/null
@@ -1,15 +0,0 @@
-# Swarm2Fediverse
-
-Foursquare Swarm like Telegram bot to checkin at places and post to Fediverse (Mastodon/Pleroma)
-
-TODO:
-
-- Option to set individual checkin visibility
-- Amazon .bot domain
-- i18n
-- Anonymized analysis
-- OAuth login to Mastodon/Pleroma
-- Delayed checkins
-- user usage count, add Telegram payment option
-- connect one Telegram user to multiple Fediverse accounts
-- Docker deployment, CI/CD, API Gateway
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1dd14e5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# Checkin.bot
+
+Foursquare Swarm like Telegram bot to check in at places and post to Fediverse (Mastodon/Pleroma)
+
+## Features
+
+- [x] Telegram native location venue checkin
+- [x] Telegram raw GPS location checkin
+- [x] Attach additional comments and medias (photos, up to 4) with checkins
+
+## TODO:
+
+- [x] OAuth2 login
+    
+    - Supported Fediverse software
+    - [x] Mastodon
+    - [ ] Pleroma
+    - [ ] Misskey
+
+- [ ] Option to set individual checkin visibility
+- [ ] Delayed checkins (Scheduled posts on Fediverse)
+- [ ] Connect multiple Fediverse accounts
+- [ ] .bot domain
+- [ ] CI/CD, Tyk API Gateway
+- [ ] add Telegram payment option to enable raw GPS checkins
+- [ ] i18n
+- [ ] Anonymized analysis
diff --git a/dbstore/peewee_store.py b/dbstore/peewee_store.py
index 272e230..d124de2 100644
--- a/dbstore/peewee_store.py
+++ b/dbstore/peewee_store.py
@@ -16,6 +16,8 @@ class BaseModel(Model):
 
 class User(BaseModel):
     telegram_user_id = CharField(unique=True, primary_key=True)
+    # TODO:
+    # add AES encryption to access_key
     access_key = CharField(max_length=64)
     home_instance = CharField(max_length=128)
     state = CharField(max_length=128)
-- 
cgit v1.2.3