diff --git a/README.md b/README.md index fc08534..651c0f4 100644 --- a/README.md +++ b/README.md @@ -28,5 +28,30 @@ jobs: # Runs djdefi/cloc-action - name: Count Lines of Code (cloc) - uses: djdefi/cloc-action@5 + uses: djdefi/cloc-action@6 ``` + +## Additional Options + +The `cloc-action` allows you to provide additional options to customize your usage. These can be passed during the step execution in your workflow file. The options are passed to the underlying `cloc` tool. + +Here is an example of how to provide additional options: + +```yaml +- name: Count Lines of Code with additional options + uses: djdefi/cloc-action@main + with: + options: --exclude-lang=YAML --md --report-file=cloc.md +``` + +In the example above: + +`--exclude-lang=YAML` is used to exclude YAML files from the count. +`--md` is used to generate the output in markdown format. +`--report-file=cloc.md` is used to write the output to the `cloc.md` file. + +These are just a few examples, other options are available based on your needs, some of which you can find in the [`cloc` documentation](https://github.com/AlDanial/cloc). + +Note: Please provide the options without any quotes. Any options requiring quotes should be escaped inside a string. For example, `options: "--exclude-dir=path\ to\ folder"` + +This level of customization lets you control how `cloc` works based on the specific needs of your project.