Updating

DaanV2 · Mar 16, 2024 · bbc72ca · bbc72ca
1 parent 8dce7da
commit bbc72ca
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -16,8 +16,8 @@ It creates a list of each markdown file in the folders and displays it under doc
 | `folder`       | ✅        | The folder path to start at, default uses `${{github.workspace}}`                                                                              |
 | `filename`     | ✅        | The filename of the generated file. default to `index`                                                                                         |
 | `content-file` | ✅        | The filepath (relative to where the README.md or index.md) where content will be read from and input into index file, default to `.content.md` |
-| `include`      | ✅        | The files to additionaly include in the index file, follows grep pattern on the filenames, supports multiple patterns via multi-line string`   |
-| `exclude`      | ✅        | The files to exclude from the index file, follows grep pattern on the filenames, supports multiple patterns via multi-line string              |
+| `include`      | ✅        | The files to additionaly include in the index file, follows glob pattern on the filenames, supports multiple patterns via multi-line string`   |
+| `exclude`      | ✅        | The files to exclude from the index file, follows glob pattern on the filenames, supports multiple patterns via multi-line string              |
 
 ## Examples
 
@@ -74,4 +74,9 @@ jobs:
   with: 
     folder: ${{github.workspace}}
     filename: README.md
+    include: |
+      *.pdf
+      *.mobi
+      *.epub
+      *.zip
 ```
diff --git a/action.yml b/action.yml
@@ -17,11 +17,11 @@ inputs:
     required: false
     default: ".content.md"
   include:
-    description: The files to additionaly include in the index file, follows grep pattern on the filenames, supports multiple patterns via multi-line string
+    description: The files to additionaly include in the index file, follows glob pattern on the filenames, supports multiple patterns via multi-line string
     required: false
     default: ""
   exclude:
-    description: The files to exclude from the index file, follows grep pattern on the filenames, supports multiple patterns via multi-line string
+    description: The files to exclude from the index file, follows glob pattern on the filenames, supports multiple patterns via multi-line string
     required: false
     default: ""
 runs: