diff --git a/README.md b/README.md index c129beb..6415edc 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,19 @@ A XMPP puppeteering gateway based on Slidge and Instagrapi Chat with Instagram users wthout leaving XMPP. + +> [!WARNING] +> The only 2FA supported is TOTP, sms/whatsapp does not work with Instagrapi for now. + +> [!WARNING] +> Less than alpha software, this does not work + +## Development Environment + +1. Run `./copier-run.sh` +2. CD into `slidge-insthidge` +3. Run `docker compose up -d`, and `docker compose logs -f` to see the logs. +4. Use Gajim to login to `test@localhost` with password `password` +5. Make changes ✨ +6. Run `docker compose down` +7. Remove the `slidge-insthidge` if you like. \ No newline at end of file