Update README.md

README.md

@@ -37,6 +37,57 @@ Cradle is a command-line utility that creates projects from templates.
 It is similar to the popular
 [Cookiecutter](https://cookiecutter.readthedocs.io/en/stable/#) project.
 
+### Help
+
+We essentially expose the copier interface directly with
+minor modifications, e.g. if the user is not submitting a source template
+we offer to choose one of the standard templates.
+
+The command line interface supports additional flags, e.g. **kwargs arguments
+for the function exposed. Hence in the standard
+
+```bash
+uv run cradle --help
+```
+
+help would be interpreted as an argument for the cradle function. We recommend
+using via
+
+```bash
+uv run cradle -- --help
+```
+
+indicating that help is an argument for the actual command line application.
+It will result in
+
+```bash
+NAME
+    cradle - The CRADLE interface. Create GitHub repositories from the command line. It is also possible to create a large number of GitHub repositories.
+
+SYNOPSIS
+    cradle <flags>
+
+DESCRIPTION
+    The CRADLE interface. Create GitHub repositories from the command line. It is also possible to create a large number of GitHub repositories.
+
+FLAGS
+    -t, --template=TEMPLATE
+        Type: Optional[str]
+        Default: None
+        optional (str) template. Use a git URI, e.g. 'git@...'. Offers a group of standard templates to choose from if not specified.
+    -d, --dst_path=DST_PATH
+        Type: Optional[str]
+        Default: None
+        optional (str) destination path. Useful when updating existing projects.
+    -v, --vcs_ref=VCS_REF
+        Type: Optional[str | None]
+        Default: None
+        optional (str) revision number to checkout a particular Git ref before generating the project.
+    Additional flags are accepted.
+```
+
+### Templates
+
 You could create your own templates and standardize project structures
 across your team or organization.
 It's essentially a project scaffolding tool that helps maintain consistency
@@ -48,13 +99,13 @@ We currently offer $3$ templates out of the box
 - The experiments template
 - The package template
 
-## Standard Templates
+#### Standard Templates
 
 We follow the one template, one repository policy.
 You are encouraged to create your own templates and we give $3$ examples that
 may serve as inspiration
 
-### [The document template](https://github.com/tschm/paper)
+##### [The document template](https://github.com/tschm/paper)
 
 The template supports the fast creation of repositories of LaTeX documents.
 Out of the box you get
@@ -64,7 +115,7 @@ Out of the box you get
 - Makefile
 - Example *.tex and bib file.
 
-### [The experiments template](https://github.com/tschm/experiments)
+##### [The experiments template](https://github.com/tschm/experiments)
 
 Here we support the creation of notebooks without the ambition to release software.
 The repo is not minimalistic but comes with a curated set of pre-commit hooks and
@@ -77,7 +128,7 @@ follows modern and established guidelines.
 - Makefile
 - marimo support
 
-### [The package template](https://github.com/tschm/package)
+##### [The package template](https://github.com/tschm/package)
 
 The package template is most useful when the final
 goal is the release of software to a registry, e.g. pypi.
@@ -92,12 +143,12 @@ It features include
 - JupyterBook
 - pdoc documentation
 
-## Proprietary templates
+#### Proprietary templates
 
-### Creation
+##### Creation
 
 You can create your very own templates and we recommend to start with
-forking the
+forking the 
 [dedicated repo](https://github.com/tschm/template/blob/main/README.md).
 Templates rely on [Jinja](https://jinja.palletsprojects.com/en/stable/).
 At the root level the repo needs a 'copier.yml' file and a 'template' folder.
@@ -106,26 +157,20 @@ Each template is tested using [act](https://github.com/nektos/act), e.g.
 we render the project template and test the workflows of the created project.
 This helps to avoid creating projects starting their life in a broken state.
 
-### Usage
+##### Usage
 
 We essentially expose the copier interface directly with
 minor modification, e.g. if the user is not submitting a source template
-we offer to pick one of the standard templates.
+we offer to choose one of the standard templates.
 
-Using the command line interface it is hence possible to
+The command line interface supports additional flags, e.g. **kwargs arguments
+for the function exposed. Hence in the standard
 
 ```bash
-uv run cradle --help DOES NOT WORK AT THE MOMENT
+uv run cradle --[email protected]:tschm/paper.git
 ```
 
-but also
-
-```bash
-uv run cradle
-```
-
-
-
+If the vcs_
 
 
 ## :warning: Private repositories