path: root/README.md

# 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
    - [x] Pleroma
    - [ ] Misskey

- [ ] Option to set individual checkin visibility
- [ ] Delayed checkins (Scheduled posts on Fediverse)
- [ ] Connect multiple Fediverse accounts
- [ ] add Telegram payment option to enable raw GPS checkins
- [ ] i18n
- [ ] Anonymized usage analysis, monitoring (Grafana/Prometheus)
- [ ] Prometheus metrics endpoint