Add development environment instrucctions

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.

UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org/>