Merge pull request #9 from DimuthuMadushan/main

Add Package.md File
ballerina-platform · Nov 8, 2023 · 0079842 · 0079842
2 parents 2c4a288 + 701853d
commit 0079842
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/copybook-tool/Module.md b/copybook-tool/Module.md
@@ -0,0 +1,10 @@
+## Overview
+
+The Copybook tool simplifies the process of transforming Copybook definitions into Ballerina code.
+
+### Command for Ballerina Copybook type generation
+
+| Argument                      | Description                                                                                                                                                                                                                                                                  |
+|-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| -i, --input                   | The `input` parameter specifies the path of the Copybook definition file (e.g., Copybook.cpy). This parameter is mandatory.                                                                                                                                                  |
+| -o, --output                  | The `output` parameter specifies the path of the output location of the generated Ballerina type file. This parameter is optional. If this parameter is not specified, the service files will be generated at the same location from which the Copybook command is executed. |
diff --git a/copybook-tool/Package.md b/copybook-tool/Package.md
@@ -0,0 +1,10 @@
+## Package overview
+
+The Copybook tool simplifies the process of transforming Copybook definitions into Ballerina code.
+
+### Command for Ballerina Copybook type generation
+
+| Argument                      | Description                                                                                                                                                                                                                                                                  |
+|-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| -i, --input                   | The `input` parameter specifies the path of the Copybook definition file (e.g., Copybook.cpy). This parameter is mandatory.                                                                                                                                                  |
+| -o, --output                  | The `output` parameter specifies the path of the output location of the generated Ballerina type file. This parameter is optional. If this parameter is not specified, the service files will be generated at the same location from which the Copybook command is executed. |