New version

README.md

@@ -40,10 +40,12 @@ matrix_synapse_container_image_customizations_dockerfile_body_custom: |
 matrix_synapse_modules:
   - module: "synapse_super_invites.SynapseSuperInvites"
     config:
-      sql_url: "sqlite:///"
+      sql_url: "sqlite://///matrix-media-store-parent/super_invites.db"
       generate_registration_token: true
 ```
 
+This creates a super_invites database persistent across restarts and docker rebuilds, you can find in `/matrix/synapse/storage` on your host.
+
 ### Confirming
 
 You can confirm the installation went well by trying to access the path `/_synapse/client/super_invites/tokens` on your matrix server. If the module is available this will return with a `401` with `errCode: M_MISSING_TOKEN`. If it isn't available you will get a `404` with `"errcode: "M_UNRECOGNIZED"`.
@@ -52,6 +54,11 @@ You can confirm the installation went well by trying to access the path `/_synap
 
 ## Changelog
 
+**0.8.0** - 2023-11-24:
+
+- documentation about how to use this with the docker-ansible-scripts
+- roadmap info added
+
 **0.8.0b3** - 2023-11-17:
 
 - Migration file inclusion
@@ -64,6 +71,13 @@ You can confirm the installation went well by trying to access the path `/_synap
 
 - First attempt at releasing
 
+## Roadmap
+
+What is missing for a 1.0?
+
+- Allow room-admins to know about all SuperInviteTokens for the given room
+- Web-Frontend to allow anyone to use this (is this even possible?)
+
 ## Development
 
 In a virtual environment with pip ≥ 21.1, run

synapse_super_invites/__init__.py

@@ -10,7 +10,7 @@
 from .config import SynapseSuperInvitesConfig, run_alembic
 from .resource import RedeemResource, TokensResource, WebAccessResource
 
-__version__ = "0.8.0b3"
+__version__ = "0.8.0"
 
 PKG_DIR = os.path.dirname(os.path.realpath(__file__))