Updated README.

tj-actions · Nov 15, 2023 · 51a78da · 51a78da
1 parent 3d78f99
commit 51a78da
Showing 1 changed file with 73 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -64,25 +64,79 @@ and/or `Description` (only supported by actions)
 
 <!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
 
-|          INPUT          |  TYPE  | REQUIRED |           DEFAULT            |                                           DESCRIPTION                                            |
-|-------------------------|--------|----------|------------------------------|--------------------------------------------------------------------------------------------------|
-|        bin\_path         | string |  false   |                              |                                   Path to the auto-doc binary                                    |
-|      col\_max\_width      | string |  false   |           `"1000"`           |                                      Max width of a column                                       |
-|      col\_max\_words      | string |  false   |            `"5"`             |                          Max number of words per line <br>in a column                            |
-|        filename         | string |  false   |        `"action.yml"`        |                                      Path to the yaml file                                       |
-|      input\_columns      | string |  false   |                              |    List of action.yml **input** columns names <br>to display, default (display all columns)      |
-|     markdown\_links      | string |  false   |           `"true"`           |  Boolean indicating whether to output input, <br>output and secret names as markdown <br>links   |
-|         output          | string |  false   |        `"README.md"`         |                                     Path to the output file                                      |
-|     output\_columns      | string |  false   |                              |    List of action.yml **output** column names <br>to display, default (display all columns)      |
-|       repository        | string |  false   | `"${{ github.repository }}"` |                Repository name with owner. For example, <br>tj-actions/auto-doc                  |
-|        reusable         | string |  false   |                              |                 Boolean Indicating whether the file is <br>a reusable workflow                   |
-| reusable\_input\_columns  | string |  false   |                              | List of reusable workflow **input** column <br>names to display, default (display all columns)   |
-| reusable\_output\_columns | string |  false   |                              | List of reusable workflow **output** column <br>names to display, default (display all columns)  |
-| reusable\_secret\_columns | string |  false   |                              | List of reusable workflow **secret** column <br>names to display, default (display all columns)  |
-|          token          | string |  false   |   `"${{ github.token }}"`    |     GitHub token or Personal Access Token <br>used to fetch the repository latest <br>tag.       |
-|     use\_code\_blocks     | string |  false   |          `"false"`           |                                 Enable code block documentation                                  |
-|    use\_major\_version    | string |  false   |          `"false"`           |                Use the major version of the <br>repository tag e.g v1.0.0 -> v1                  |
-|         version         | string |  false   |                              |                                    The version number to run                                     |
+```yaml
+- uses: tj-actions/auto-doc@v3
+  id: auto-doc
+  with:
+    # Path to the auto-doc binary
+    bin_path: ''
+
+    # Max width of a column
+    # Default: 1000
+    col_max_width: ''
+
+    # Max number of words per line in a column
+    # Default: 5
+    col_max_words: ''
+
+    # Path to the yaml file
+    # Default: action.yml
+    filename: ''
+
+    # List of action.yml **input** columns names to display, default 
+    # (display all columns) 
+    input_columns: ''
+
+    # Boolean indicating whether to output input, output and secret 
+    # names as markdown links 
+    # Default: true
+    markdown_links: ''
+
+    # Path to the output file
+    # Default: README.md
+    output: ''
+
+    # List of action.yml **output** column names to display, default 
+    # (display all columns) 
+    output_columns: ''
+
+    # Repository name with owner. For example, tj-actions/auto-doc
+    # Default: ${{ github.repository }}
+    repository: ''
+
+    # Boolean Indicating whether the file is a reusable workflow
+    reusable: ''
+
+    # List of reusable workflow **input** column names to display, 
+    # default (display all columns) 
+    reusable_input_columns: ''
+
+    # List of reusable workflow **output** column names to display, 
+    # default (display all columns) 
+    reusable_output_columns: ''
+
+    # List of reusable workflow **secret** column names to display, 
+    # default (display all columns) 
+    reusable_secret_columns: ''
+
+    # GitHub token or Personal Access Token used to fetch 
+    # the repository latest tag. 
+    # Default: ${{ github.token }}
+    token: ''
+
+    # Enable code block documentation
+    # Default: false
+    use_code_blocks: ''
+
+    # Use the major version of the repository tag e.g 
+    # v1.0.0 -> v1 
+    # Default: false
+    use_major_version: ''
+
+    # The version number to run
+    version: ''
+
+```
 
 <!-- AUTO-DOC-INPUT:END -->