Add publish command to README

marcggl · May 14, 2024 · caed695 · caed695
1 parent fb343fe
commit caed695
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -184,6 +184,7 @@ Commands
 - [changelog](#changelog)
 - [diff](#diff)
 - [catalog](#catalog)
+- [publish](#publish)
 
 ### init
 
@@ -767,6 +768,21 @@ Available import options:
 ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
 ```
 
+### Publish
+
+```
+
+ Usage: datacontract publish [OPTIONS] [LOCATION]
+
+ Publish the data contract to the Data Mesh Manager.
+
+╭─ Arguments ────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│   location      [LOCATION]  The location (url or path) of the data contract yaml. [default: datacontract.yaml]             │
+╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --help          Show this message and exit.                                                                                │
+╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+```
 
 ## Integrations
 

diff --git a/datacontract/cli.py b/datacontract/cli.py
@@ -244,7 +244,7 @@ def publish(
     ] = "datacontract.yaml",
 ):
     """
-    Publish the data contract to the Data Mesh Manager
+    Publish the data contract to the Data Mesh Manager.
     """
     publish_to_datamesh_manager(
         data_contract=DataContract(data_contract_file=location),