docs: update readme

cli/src/service.py

@@ -9,17 +9,24 @@ service = typer.Typer(no_args_is_help=True)
 REPO_ROOT = get_git_root(__file__)
 
 
-@service.command(no_args_is_help=True)
+@service.command(
+    no_args_is_help=True,
+    help="Running this command will create a new branch 'feature/add-service-<name>', "
+    "add all the required files for a new service, and push. "
+    "See: https://gitea.psi.ch/sls/hla_framework_bd/branches",
+)
 def add(
-    name: str = typer.Option(..., "--name", "-n"),
-    user: str = typer.Option(..., "--user", "-u"),
+    name: str = typer.Option(
+        ..., "--name", "-n", help="Must only contain lowercase characters and dashes"
+    ),
+    user: str = typer.Option(..., "--user", "-u", help="PSI username of the owner of the service"),
     ioc_description: str = typer.Option(
         ..., "--ioc-description", "-d", help="See <repo-root>/docs/ioc/ioc_overview.md for examples"
     ),
     ui_name: str = typer.Option(
         ...,
         "--ui-name",
-        help="This is the name that will be used for the service in the UI."
+        help="This is the name that will be used for the service in the UI. "
         "See <repo-root>/qt/A_BD_ServiceManager.ui for examples",
     ),
     ui_filename: str = typer.Option(
@@ -64,7 +71,7 @@ def migrate(
     service_creator.migrate_service(name=name)
 
 
-@service.command(no_args_is_help=True)
+@service.command()
 def list():
     registry = ServiceRegistry.read_from_config()
     services = registry.get_services()