rename to hivemind-audio-binary-protocol

JarbasHiveMind · Dec 29, 2024 · 4970f7a · 4970f7a
1 parent 0162dc9
commit 4970f7a
Show file tree

Hide file tree

Showing 10 changed files with 494 additions and 66 deletions.
diff --git a/.github/workflows/publish_stable.yml b/.github/workflows/publish_stable.yml
@@ -10,7 +10,7 @@ jobs:
     secrets: inherit
     with:
       branch: 'master'
-      version_file: 'hivemind_listener/version.py'
+      version_file: 'hivemind_audio_binary_protocol/version.py'
       setup_py: 'setup.py'
       publish_release: true
 

diff --git a/.github/workflows/release_workflow.yml b/.github/workflows/release_workflow.yml
@@ -12,7 +12,7 @@ jobs:
     secrets: inherit
     with:
       branch: 'dev'
-      version_file: 'hivemind_listener/version.py'
+      version_file: 'hivemind_audio_binary_protocol/version.py'
       setup_py: 'setup.py'
       update_changelog: true
       publish_prerelease: true

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# HiveMind Listener
+# HiveMind Audio Binary Protocol Plugin
 
-HiveMind Listener extends [hivemind-core](https://github.com/JarbasHiveMind/hivemind-core) and integrates with [ovos-simple-listener](https://github.com/TigreGotico/ovos-simple-listener), enabling audio-based communication with advanced features for **secure, distributed voice assistant functionality**.
+Extends [hivemind-core](https://github.com/JarbasHiveMind/hivemind-core) and integrates with [ovos-simple-listener](https://github.com/TigreGotico/ovos-simple-listener), enabling audio-based communication with advanced features for **secure, distributed voice assistant functionality**.
 
 ---
 
@@ -20,7 +20,7 @@ HiveMind Listener extends [hivemind-core](https://github.com/JarbasHiveMind/hive
   Running **TTS/STT via HiveMind Listener** requires an access key, offering fine-grained **access control** compared to non-authenticated server plugins.
 
 
-> 💡 **Tip**: HiveMind Listener replaces `hivemind-core` and is compatible with all existing HiveMind clients.
+> 💡 **Tip**: `hivemind-audio-binary-protocol` is a plugin for `hivemind-core` and is compatible with all existing HiveMind clients.
 
 ---
 
@@ -29,54 +29,7 @@ HiveMind Listener extends [hivemind-core](https://github.com/JarbasHiveMind/hive
 ### Installation
 
 ```bash
-pip install hivemind-listener
-```
-
----
-
-## 🛠️ Commands Overview
-
-```bash
-$ hivemind-listener --help
-Usage: hivemind-listener [OPTIONS] 
-
-  Run the HiveMind Listener with configurable plugins.
-
-  If a plugin is not specified, the defaults from mycroft.conf will be used.
-
-  mycroft.conf will be loaded as usual for plugin settings
-
-Options:
-  --wakeword TEXT                 Specify the wake word for the listener.
-                                  Default is 'hey_mycroft'.
-  --stt-plugin TEXT               Specify the STT plugin to use.
-  --tts-plugin TEXT               Specify the TTS plugin to use.
-  --vad-plugin TEXT               Specify the VAD plugin to use.
-  --dialog-transformers TEXT      dialog transformer plugins to load.
-                                  Installed plugins: None
-  --utterance-transformers TEXT   utterance transformer plugins to load. 
-                                  Installed plugins: ['ovos-utterance-plugin-cancel']
-  --metadata-transformers TEXT    metadata transformer plugins to
-                                  load. Installed plugins: None
-  --ovos_bus_address TEXT         Open Voice OS bus address
-  --ovos_bus_port INTEGER         Open Voice OS bus port number
-  --host TEXT                     HiveMind host
-  --port INTEGER                  HiveMind port number
-  --ssl BOOLEAN                   use wss://
-  --cert_dir TEXT                 HiveMind SSL certificate directory
-  --cert_name TEXT                HiveMind SSL certificate file name
-  --db-backend [redis|json|sqlite]
-                                  Select the database backend to use. Options:
-                                  redis, sqlite, json.
-  --db-name TEXT                  [json/sqlite] The name for the database
-                                  file. ~/.cache/hivemind-core/{name}
-  --db-folder TEXT                [json/sqlite] The subfolder where database
-                                  files are stored. ~/.cache/{db_folder}}
-  --redis-host TEXT               [redis] Host for Redis. Default is
-                                  localhost.
-  --redis-port INTEGER            [redis] Port for Redis. Default is 6379.
-  --redis-password TEXT           [redis] Password for Redis. Default None
-  --help                          Show this message and exit.
+pip install hivemind-audio-binary-protocol
 ```
 
 ---