mmrelay 1.0.7__tar.gz → 1.0.8__tar.gz

{mmrelay-1.0.7 → mmrelay-1.0.8}/MANIFEST.in

@@ -1,6 +1,4 @@
 include LICENSE
 include README.md
 include requirements.txt
-include sample_config.yaml
-recursive-include tools *
 recursive-include src/mmrelay/tools *

{mmrelay-1.0.7/src/mmrelay.egg-info → mmrelay-1.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mmrelay
-Version: 1.0.7
+Version: 1.0.8
 Summary: Bridge between Meshtastic mesh networks and Matrix chat rooms
 Home-page: https://github.com/geoffwhittington/meshtastic-matrix-relay
 Author: Geoff Whittington, Jeremiah K., and contributors
@@ -22,72 +22,45 @@ Requires-Dist: requests==2.32.3
 Requires-Dist: markdown==3.8
 Requires-Dist: haversine==2.9.0
 Requires-Dist: schedule==1.2.2
-Requires-Dist: platformdirs==4.3.7
+Requires-Dist: platformdirs==4.3.8
 Requires-Dist: py-staticmaps>=0.4.0
 Requires-Dist: rich==14.0.0
-Requires-Dist: setuptools==80.3.1
+Requires-Dist: setuptools==80.8.0
 Dynamic: license-file
 
 # M<>M Relay
 
-## ✨ Version 1.0 Released! ✨
+## (Meshtastic <=> Matrix Relay)
 
-**We're excited to announce MMRelay v1.0 with improved packaging, standardized directories, and enhanced CLI!**
+A powerful and easy-to-use relay between Meshtastic devices and Matrix chat rooms, allowing seamless communication across platforms. This opens the door for bridging Meshtastic devices to [many other platforms](https://matrix.org/bridges/).
 
-**Existing users:** Version 1.0 requires a few quick migration steps:
+## Documentation
 
-1. Follow the [UPGRADE_TO_V1.md](UPGRADE_TO_V1.md) guide for a smooth transition
-2. Move your configuration to the new standard location (`~/.mmrelay/config.yaml`)
-3. See [ANNOUNCEMENT.md](ANNOUNCEMENT.md) for all the exciting new features
+Visit our [Wiki](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki) for comprehensive guides and information.
 
-Not ready to upgrade yet? No problem! Run `git checkout 0.10.1` to continue using the previous version.
-
-## (Meshtastic <=> Matrix Relay)
-
-A powerful and easy-to-use relay between Meshtastic devices and Matrix chat rooms, allowing seamless communication across platforms. This opens the door for bridging Meshtastic devices to [many other platforms](https://matrix.org/bridges/).
+- [Installation Instructions](docs/INSTRUCTIONS.md) - Setup and configuration guide
+- [v1.0 Release Announcement](docs/ANNOUNCEMENT.md) - New changes in v1.0
+- [Upgrade Guide](docs/UPGRADE_TO_V1.md) - Migration guidance for existing users
 
 ---
 
-## Getting Started
+## Quick Start
 
 MMRelay runs on Linux, macOS, and Windows.
 
-### Quick Installation
-
 ```bash
 # Install using pipx for isolated installation (recommended)
 pipx install mmrelay
 
-# Pip will also work if you prefer
-pip install mmrelay
-```
-
-For pipx installation instructions, see: [pipx installation guide](https://pipx.pypa.io/stable/installation/#on-linux)
+# Generate a sample configuration file & then edit it
+mmrelay --generate-config
 
-### Resources
-
-- **New Users**: See [INSTRUCTIONS.md](INSTRUCTIONS.md) for setup and configuration
-- **Existing Users**: See [UPGRADE_TO_V1.md](UPGRADE_TO_V1.md) for migration guidance
-- **Configuration**: Review [sample_config.yaml](src/mmrelay/tools/sample_config.yaml) for examples
-
-### Command-Line Options
-
-```bash
-usage: mmrelay [-h] [--config CONFIG] [--data-dir DATA_DIR] [--log-level {error,warning,info,debug}] [--logfile LOGFILE] [--version] [--generate-config] [--install-service] [--check-config]
-
-Options:
-  -h, --help            Show this help message and exit
-  --config CONFIG       Path to config file
-  --data-dir DATA_DIR   Base directory for all data (logs, database, plugins)
-  --log-level {error,warning,info,debug}
-                        Set logging level
-  --logfile LOGFILE     Path to log file (can be overridden by --data-dir)
-  --version             Show version and exit
-  --generate-config     Generate a sample config.yaml file
-  --install-service     Install or update the systemd user service
-  --check-config        Check if the configuration file is valid
+# Start the relay (without --install-service to run manually)
+mmrelay --install-service
 ```
 
+For detailed installation and configuration instructions, see the [Installation Guide](docs/INSTRUCTIONS.md).
+
 ---
 
 ## Features
@@ -133,7 +106,12 @@ See the full list of core plugins [here](https://github.com/geoffwhittington/mes
 
 ### Community & Custom Plugins
 
-It is possible to create custom plugins and share them with the community. Check [example_plugins/README.md](https://github.com/geoffwhittington/meshtastic-matrix-relay/tree/main/example_plugins) and the [Community Plugins Development Guide](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki/Community-Plugin-Development-Guide).
+MMRelay's plugin system allows you to extend functionality in two ways:
+
+- **Custom Plugins**: Create personal plugins for your own use, stored in `~/.mmrelay/plugins/custom/`
+- **Community Plugins**: Share your creations with others or use plugins developed by the community
+
+Check the [Community Plugins Development Guide](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki/Community-Plugin-Development-Guide) in our wiki to get started.
 
 ✨️ Visit the [Community Plugins List](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki/Community-Plugin-List)!
 
@@ -151,14 +129,12 @@ community-plugins:
 
 ### Plugin System
 
-MMRelay features a powerful plugin system with standardized locations:
+Plugins make it easy to extend functionality without modifying the core program. MMRelay features a powerful plugin system with standardized locations:
 
 - **Core Plugins**: Pre-installed with the package
 - **Custom Plugins**: Your own plugins in `~/.mmrelay/plugins/custom/`
 - **Community Plugins**: Third-party plugins in `~/.mmrelay/plugins/community/`
 
-Plugins make it easy to extend functionality without modifying the core code.
-
 ---
 
 ## Getting Started with Matrix

{mmrelay-1.0.7 → mmrelay-1.0.8}/README.md

@@ -1,63 +1,36 @@
 # M<>M Relay
 
-## ✨ Version 1.0 Released! ✨
+## (Meshtastic <=> Matrix Relay)
 
-**We're excited to announce MMRelay v1.0 with improved packaging, standardized directories, and enhanced CLI!**
+A powerful and easy-to-use relay between Meshtastic devices and Matrix chat rooms, allowing seamless communication across platforms. This opens the door for bridging Meshtastic devices to [many other platforms](https://matrix.org/bridges/).
 
-**Existing users:** Version 1.0 requires a few quick migration steps:
+## Documentation
 
-1. Follow the [UPGRADE_TO_V1.md](UPGRADE_TO_V1.md) guide for a smooth transition
-2. Move your configuration to the new standard location (`~/.mmrelay/config.yaml`)
-3. See [ANNOUNCEMENT.md](ANNOUNCEMENT.md) for all the exciting new features
+Visit our [Wiki](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki) for comprehensive guides and information.
 
-Not ready to upgrade yet? No problem! Run `git checkout 0.10.1` to continue using the previous version.
-
-## (Meshtastic <=> Matrix Relay)
-
-A powerful and easy-to-use relay between Meshtastic devices and Matrix chat rooms, allowing seamless communication across platforms. This opens the door for bridging Meshtastic devices to [many other platforms](https://matrix.org/bridges/).
+- [Installation Instructions](docs/INSTRUCTIONS.md) - Setup and configuration guide
+- [v1.0 Release Announcement](docs/ANNOUNCEMENT.md) - New changes in v1.0
+- [Upgrade Guide](docs/UPGRADE_TO_V1.md) - Migration guidance for existing users
 
 ---
 
-## Getting Started
+## Quick Start
 
 MMRelay runs on Linux, macOS, and Windows.
 
-### Quick Installation
-
 ```bash
 # Install using pipx for isolated installation (recommended)
 pipx install mmrelay
 
-# Pip will also work if you prefer
-pip install mmrelay
-```
-
-For pipx installation instructions, see: [pipx installation guide](https://pipx.pypa.io/stable/installation/#on-linux)
+# Generate a sample configuration file & then edit it
+mmrelay --generate-config
 
-### Resources
-
-- **New Users**: See [INSTRUCTIONS.md](INSTRUCTIONS.md) for setup and configuration
-- **Existing Users**: See [UPGRADE_TO_V1.md](UPGRADE_TO_V1.md) for migration guidance
-- **Configuration**: Review [sample_config.yaml](src/mmrelay/tools/sample_config.yaml) for examples
-
-### Command-Line Options
-
-```bash
-usage: mmrelay [-h] [--config CONFIG] [--data-dir DATA_DIR] [--log-level {error,warning,info,debug}] [--logfile LOGFILE] [--version] [--generate-config] [--install-service] [--check-config]
-
-Options:
-  -h, --help            Show this help message and exit
-  --config CONFIG       Path to config file
-  --data-dir DATA_DIR   Base directory for all data (logs, database, plugins)
-  --log-level {error,warning,info,debug}
-                        Set logging level
-  --logfile LOGFILE     Path to log file (can be overridden by --data-dir)
-  --version             Show version and exit
-  --generate-config     Generate a sample config.yaml file
-  --install-service     Install or update the systemd user service
-  --check-config        Check if the configuration file is valid
+# Start the relay (without --install-service to run manually)
+mmrelay --install-service
 ```
 
+For detailed installation and configuration instructions, see the [Installation Guide](docs/INSTRUCTIONS.md).
+
 ---
 
 ## Features
@@ -103,7 +76,12 @@ See the full list of core plugins [here](https://github.com/geoffwhittington/mes
 
 ### Community & Custom Plugins
 
-It is possible to create custom plugins and share them with the community. Check [example_plugins/README.md](https://github.com/geoffwhittington/meshtastic-matrix-relay/tree/main/example_plugins) and the [Community Plugins Development Guide](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki/Community-Plugin-Development-Guide).
+MMRelay's plugin system allows you to extend functionality in two ways:
+
+- **Custom Plugins**: Create personal plugins for your own use, stored in `~/.mmrelay/plugins/custom/`
+- **Community Plugins**: Share your creations with others or use plugins developed by the community
+
+Check the [Community Plugins Development Guide](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki/Community-Plugin-Development-Guide) in our wiki to get started.
 
 ✨️ Visit the [Community Plugins List](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki/Community-Plugin-List)!
 
@@ -121,14 +99,12 @@ community-plugins:
 
 ### Plugin System
 
-MMRelay features a powerful plugin system with standardized locations:
+Plugins make it easy to extend functionality without modifying the core program. MMRelay features a powerful plugin system with standardized locations:
 
 - **Core Plugins**: Pre-installed with the package
 - **Custom Plugins**: Your own plugins in `~/.mmrelay/plugins/custom/`
 - **Community Plugins**: Third-party plugins in `~/.mmrelay/plugins/community/`
 
-Plugins make it easy to extend functionality without modifying the core code.
-
 ---
 
 ## Getting Started with Matrix

{mmrelay-1.0.7 → mmrelay-1.0.8}/requirements.txt

@@ -6,7 +6,7 @@ requests==2.32.3
 markdown==3.8
 haversine==2.9.0
 schedule==1.2.2
-platformdirs==4.3.7
+platformdirs==4.3.8
 py-staticmaps>=0.4.0
 rich==14.0.0
-setuptools==80.3.1
+setuptools==80.8.0

{mmrelay-1.0.7 → mmrelay-1.0.8}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = mmrelay
-version = 1.0.7
+version = 1.0.8
 author = Geoff Whittington, Jeremiah K., and contributors
 author_email = jeremiahk@gmx.com
 description = Bridge between Meshtastic mesh networks and Matrix chat rooms
@@ -30,10 +30,10 @@ install_requires =
 	markdown==3.8
 	haversine==2.9.0
 	schedule==1.2.2
-	platformdirs==4.3.7
+	platformdirs==4.3.8
 	py-staticmaps>=0.4.0
 	rich==14.0.0
-	setuptools==80.3.1
+	setuptools==80.8.0
 include_package_data = True
 
 [options.packages.find]

{mmrelay-1.0.7 → mmrelay-1.0.8}/src/mmrelay/__init__.py

@@ -15,4 +15,4 @@ else:
         __version__ = pkg_resources.get_distribution("mmrelay").version
     except pkg_resources.DistributionNotFound:
         # If all else fails, use hardcoded version
-        __version__ = "1.0.1"
+        __version__ = "1.0.8"

{mmrelay-1.0.7 → mmrelay-1.0.8}/src/mmrelay/main.py

@@ -9,6 +9,7 @@ import signal
 import sys
 
 from nio import ReactionEvent, RoomMessageEmote, RoomMessageNotice, RoomMessageText
+from nio.events.room_events import RoomMemberEvent
 
 # Import version from package
 # Import meshtastic_utils as a module to set event_loop
@@ -22,7 +23,7 @@ from mmrelay.db_utils import (
 from mmrelay.log_utils import get_logger
 from mmrelay.matrix_utils import connect_matrix, join_matrix_room
 from mmrelay.matrix_utils import logger as matrix_logger
-from mmrelay.matrix_utils import on_room_message
+from mmrelay.matrix_utils import on_room_message, on_room_member
 from mmrelay.meshtastic_utils import connect_meshtastic
 from mmrelay.meshtastic_utils import logger as meshtastic_logger
 from mmrelay.plugin_loader import load_plugins
@@ -109,6 +110,8 @@ async def main(config):
     )
     # Add ReactionEvent callback so we can handle matrix reactions
     matrix_client.add_event_callback(on_room_message, ReactionEvent)
+    # Add RoomMemberEvent callback to track room-specific display name changes
+    matrix_client.add_event_callback(on_room_member, RoomMemberEvent)
 
     # Set up shutdown event
     shutdown_event = asyncio.Event()

{mmrelay-1.0.7 → mmrelay-1.0.8}/src/mmrelay/matrix_utils.py

@@ -18,6 +18,7 @@ from nio import (
     UploadResponse,
     WhoamiError,
 )
+from nio.events.room_events import RoomMemberEvent
 from PIL import Image
 
 from mmrelay.db_utils import (
@@ -517,8 +518,14 @@ async def on_room_message(
             meshtastic_id, matrix_room_id, meshtastic_text_db, meshtastic_meshnet_db = (
                 orig
             )
-            display_name_response = await matrix_client.get_displayname(event.sender)
-            full_display_name = display_name_response.displayname or event.sender
+            # Get room-specific display name if available, fallback to global display name
+            room_display_name = room.user_name(event.sender)
+            if room_display_name:
+                full_display_name = room_display_name
+            else:
+                # Fallback to global display name if room-specific name is not available
+                display_name_response = await matrix_client.get_displayname(event.sender)
+                full_display_name = display_name_response.displayname or event.sender
 
             # If not from a remote meshnet, proceed as normal to relay back to the originating meshnet
             short_display_name = full_display_name[:5]
@@ -578,8 +585,14 @@ async def on_room_message(
             return
     else:
         # Normal Matrix message from a Matrix user
-        display_name_response = await matrix_client.get_displayname(event.sender)
-        full_display_name = display_name_response.displayname or event.sender
+        # Get room-specific display name if available, fallback to global display name
+        room_display_name = room.user_name(event.sender)
+        if room_display_name:
+            full_display_name = room_display_name
+        else:
+            # Fallback to global display name if room-specific name is not available
+            display_name_response = await matrix_client.get_displayname(event.sender)
+            full_display_name = display_name_response.displayname or event.sender
         short_display_name = full_display_name[:5]
         prefix = f"{short_display_name}[M]: "
         logger.debug(f"Processing matrix message from [{full_display_name}]: {text}")
@@ -752,3 +765,38 @@ async def send_room_image(
         message_type="m.room.message",
         content={"msgtype": "m.image", "url": upload_response.content_uri, "body": ""},
     )
+
+
+async def on_room_member(room: MatrixRoom, event: RoomMemberEvent) -> None:
+    """
+    Callback to handle room member events, specifically tracking room-specific display name changes.
+    This ensures we detect when users update their display names in specific rooms.
+    """
+    # Only track updates from active members
+    if event.membership != "join":
+        return
+
+    new_displayname = event.content.get("displayname")
+    old_displayname = event.prev_content.get("displayname") if event.prev_content else None
+    user_id = event.state_key
+    room_id = room.room_id
+
+    # Log display name changes for debugging
+    if new_displayname != old_displayname:
+        if new_displayname and old_displayname:
+            logger.info(
+                f"[Matrix] {user_id} updated room display name in {room_id}: "
+                f"'{old_displayname}' → '{new_displayname}'"
+            )
+        elif new_displayname and not old_displayname:
+            logger.info(
+                f"[Matrix] {user_id} set room display name in {room_id}: '{new_displayname}'"
+            )
+        elif not new_displayname and old_displayname:
+            logger.info(
+                f"[Matrix] {user_id} removed room display name in {room_id}: '{old_displayname}' → (global name)"
+            )
+
+    # Note: We don't need to maintain a separate cache here since matrix-nio
+    # automatically updates the room state and room.user_name() will return
+    # the updated room-specific display name immediately after this event.

{mmrelay-1.0.7 → mmrelay-1.0.8}/src/mmrelay/plugins/base_plugin.py

@@ -29,25 +29,28 @@ class BasePlugin(ABC):
     def description(self):
         return ""
 
-    def __init__(self) -> None:
-        # IMPORTANT NOTE FOR PLUGIN DEVELOPERS:
-        # When creating a plugin that inherits from BasePlugin, you MUST set
-        # self.plugin_name in your __init__ method BEFORE calling super().__init__()
-        # Example:
-        #   def __init__(self):
-        #       self.plugin_name = "your_plugin_name"  # Set this FIRST
-        #       super().__init__()                     # Then call parent
-        #
-        # Failure to do this will cause command recognition issues and other problems.
-
+    def __init__(self, plugin_name=None) -> None:
+        # Allow plugin_name to be passed as a parameter for simpler initialization
+        # This maintains backward compatibility while providing a cleaner API
         super().__init__()
 
-        # Verify plugin_name is properly defined
+        # If plugin_name is provided as a parameter, use it
+        if plugin_name is not None:
+            self.plugin_name = plugin_name
+
+        # For backward compatibility: if plugin_name is not provided as a parameter,
+        # check if it's set as an instance attribute (old way) or use the class attribute
         if not hasattr(self, "plugin_name") or self.plugin_name is None:
-            raise ValueError(
-                f"{self.__class__.__name__} is missing plugin_name definition. "
-                f"Make sure to set self.plugin_name BEFORE calling super().__init__()"
-            )
+            # Try to get the class-level plugin_name
+            class_plugin_name = getattr(self.__class__, "plugin_name", None)
+            if class_plugin_name is not None:
+                self.plugin_name = class_plugin_name
+            else:
+                raise ValueError(
+                    f"{self.__class__.__name__} is missing plugin_name definition. "
+                    f"Either set class.plugin_name, pass plugin_name to __init__, "
+                    f"or set self.plugin_name before calling super().__init__()"
+                )
 
         self.logger = get_logger(f"Plugin:{self.plugin_name}")
         self.config = {"active": False}
@@ -66,6 +69,8 @@ class BasePlugin(ABC):
                 room.get("meshtastic_channel")
                 for room in config.get("matrix_rooms", [])
             ]
+        else:
+            self.mapped_channels = []
 
         # Get the channels specified for this plugin, or default to all mapped channels
         self.channels = self.config.get("channels", self.mapped_channels)

{mmrelay-1.0.7 → mmrelay-1.0.8}/src/mmrelay/plugins/drop_plugin.py

@@ -10,9 +10,8 @@ class Plugin(BasePlugin):
     plugin_name = "drop"
     special_node = "!NODE_MSGS!"
 
-    def __init__(self):
-        self.plugin_name = "drop"
-        super().__init__()
+    # No __init__ method needed with the simplified plugin system
+    # The BasePlugin will automatically use the class-level plugin_name
 
     def get_position(self, meshtastic_client, node_id):
         for _node, info in meshtastic_client.nodes.items():

{mmrelay-1.0.7 → mmrelay-1.0.8}/src/mmrelay/plugins/help_plugin.py

@@ -7,9 +7,8 @@ from mmrelay.plugins.base_plugin import BasePlugin
 class Plugin(BasePlugin):
     plugin_name = "help"
 
-    def __init__(self):
-        self.plugin_name = "help"
-        super().__init__()
+    # No __init__ method needed with the simplified plugin system
+    # The BasePlugin will automatically use the class-level plugin_name
 
     @property
     def description(self):

{mmrelay-1.0.7 → mmrelay-1.0.8}/src/mmrelay/plugins/map_plugin.py

@@ -235,9 +235,8 @@ async def send_image(client: AsyncClient, room_id: str, image: Image.Image):
 class Plugin(BasePlugin):
     plugin_name = "map"
 
-    def __init__(self):
-        self.plugin_name = "map"
-        super().__init__()
+    # No __init__ method needed with the simplified plugin system
+    # The BasePlugin will automatically use the class-level plugin_name
 
     @property
     def description(self):

{mmrelay-1.0.7 → mmrelay-1.0.8}/src/mmrelay/plugins/ping_plugin.py

@@ -17,9 +17,8 @@ class Plugin(BasePlugin):
     plugin_name = "ping"
     punctuation = string.punctuation
 
-    def __init__(self):
-        self.plugin_name = "ping"
-        super().__init__()
+    # No __init__ method needed with the simplified plugin system
+    # The BasePlugin will automatically use the class-level plugin_name
 
     @property
     def description(self):

{mmrelay-1.0.7 → mmrelay-1.0.8}/src/mmrelay/plugins/weather_plugin.py

@@ -9,9 +9,8 @@ from mmrelay.plugins.base_plugin import BasePlugin
 class Plugin(BasePlugin):
     plugin_name = "weather"
 
-    def __init__(self):
-        self.plugin_name = "weather"
-        super().__init__()
+    # No __init__ method needed with the simplified plugin system
+    # The BasePlugin will automatically use the class-level plugin_name
 
     @property
     def description(self):

{mmrelay-1.0.7 → mmrelay-1.0.8/src/mmrelay.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mmrelay
-Version: 1.0.7
+Version: 1.0.8
 Summary: Bridge between Meshtastic mesh networks and Matrix chat rooms
 Home-page: https://github.com/geoffwhittington/meshtastic-matrix-relay
 Author: Geoff Whittington, Jeremiah K., and contributors
@@ -22,72 +22,45 @@ Requires-Dist: requests==2.32.3
 Requires-Dist: markdown==3.8
 Requires-Dist: haversine==2.9.0
 Requires-Dist: schedule==1.2.2
-Requires-Dist: platformdirs==4.3.7
+Requires-Dist: platformdirs==4.3.8
 Requires-Dist: py-staticmaps>=0.4.0
 Requires-Dist: rich==14.0.0
-Requires-Dist: setuptools==80.3.1
+Requires-Dist: setuptools==80.8.0
 Dynamic: license-file
 
 # M<>M Relay
 
-## ✨ Version 1.0 Released! ✨
+## (Meshtastic <=> Matrix Relay)
 
-**We're excited to announce MMRelay v1.0 with improved packaging, standardized directories, and enhanced CLI!**
+A powerful and easy-to-use relay between Meshtastic devices and Matrix chat rooms, allowing seamless communication across platforms. This opens the door for bridging Meshtastic devices to [many other platforms](https://matrix.org/bridges/).
 
-**Existing users:** Version 1.0 requires a few quick migration steps:
+## Documentation
 
-1. Follow the [UPGRADE_TO_V1.md](UPGRADE_TO_V1.md) guide for a smooth transition
-2. Move your configuration to the new standard location (`~/.mmrelay/config.yaml`)
-3. See [ANNOUNCEMENT.md](ANNOUNCEMENT.md) for all the exciting new features
+Visit our [Wiki](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki) for comprehensive guides and information.
 
-Not ready to upgrade yet? No problem! Run `git checkout 0.10.1` to continue using the previous version.
-
-## (Meshtastic <=> Matrix Relay)
-
-A powerful and easy-to-use relay between Meshtastic devices and Matrix chat rooms, allowing seamless communication across platforms. This opens the door for bridging Meshtastic devices to [many other platforms](https://matrix.org/bridges/).
+- [Installation Instructions](docs/INSTRUCTIONS.md) - Setup and configuration guide
+- [v1.0 Release Announcement](docs/ANNOUNCEMENT.md) - New changes in v1.0
+- [Upgrade Guide](docs/UPGRADE_TO_V1.md) - Migration guidance for existing users
 
 ---
 
-## Getting Started
+## Quick Start
 
 MMRelay runs on Linux, macOS, and Windows.
 
-### Quick Installation
-
 ```bash
 # Install using pipx for isolated installation (recommended)
 pipx install mmrelay
 
-# Pip will also work if you prefer
-pip install mmrelay
-```
-
-For pipx installation instructions, see: [pipx installation guide](https://pipx.pypa.io/stable/installation/#on-linux)
+# Generate a sample configuration file & then edit it
+mmrelay --generate-config
 
-### Resources
-
-- **New Users**: See [INSTRUCTIONS.md](INSTRUCTIONS.md) for setup and configuration
-- **Existing Users**: See [UPGRADE_TO_V1.md](UPGRADE_TO_V1.md) for migration guidance
-- **Configuration**: Review [sample_config.yaml](src/mmrelay/tools/sample_config.yaml) for examples
-
-### Command-Line Options
-
-```bash
-usage: mmrelay [-h] [--config CONFIG] [--data-dir DATA_DIR] [--log-level {error,warning,info,debug}] [--logfile LOGFILE] [--version] [--generate-config] [--install-service] [--check-config]
-
-Options:
-  -h, --help            Show this help message and exit
-  --config CONFIG       Path to config file
-  --data-dir DATA_DIR   Base directory for all data (logs, database, plugins)
-  --log-level {error,warning,info,debug}
-                        Set logging level
-  --logfile LOGFILE     Path to log file (can be overridden by --data-dir)
-  --version             Show version and exit
-  --generate-config     Generate a sample config.yaml file
-  --install-service     Install or update the systemd user service
-  --check-config        Check if the configuration file is valid
+# Start the relay (without --install-service to run manually)
+mmrelay --install-service
 ```
 
+For detailed installation and configuration instructions, see the [Installation Guide](docs/INSTRUCTIONS.md).
+
 ---
 
 ## Features
@@ -133,7 +106,12 @@ See the full list of core plugins [here](https://github.com/geoffwhittington/mes
 
 ### Community & Custom Plugins
 
-It is possible to create custom plugins and share them with the community. Check [example_plugins/README.md](https://github.com/geoffwhittington/meshtastic-matrix-relay/tree/main/example_plugins) and the [Community Plugins Development Guide](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki/Community-Plugin-Development-Guide).
+MMRelay's plugin system allows you to extend functionality in two ways:
+
+- **Custom Plugins**: Create personal plugins for your own use, stored in `~/.mmrelay/plugins/custom/`
+- **Community Plugins**: Share your creations with others or use plugins developed by the community
+
+Check the [Community Plugins Development Guide](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki/Community-Plugin-Development-Guide) in our wiki to get started.
 
 ✨️ Visit the [Community Plugins List](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki/Community-Plugin-List)!
 
@@ -151,14 +129,12 @@ community-plugins:
 
 ### Plugin System
 
-MMRelay features a powerful plugin system with standardized locations:
+Plugins make it easy to extend functionality without modifying the core program. MMRelay features a powerful plugin system with standardized locations:
 
 - **Core Plugins**: Pre-installed with the package
 - **Custom Plugins**: Your own plugins in `~/.mmrelay/plugins/custom/`
 - **Community Plugins**: Third-party plugins in `~/.mmrelay/plugins/community/`
 
-Plugins make it easy to extend functionality without modifying the core code.
-
 ---
 
 ## Getting Started with Matrix

{mmrelay-1.0.7 → mmrelay-1.0.8}/src/mmrelay.egg-info/requires.txt

@@ -6,7 +6,7 @@ requests==2.32.3
 markdown==3.8
 haversine==2.9.0
 schedule==1.2.2
-platformdirs==4.3.7
+platformdirs==4.3.8
 py-staticmaps>=0.4.0
 rich==14.0.0
-setuptools==80.3.1
+setuptools==80.8.0