Skip to content

Commit 67f0100

Browse files
committed
feat: Update README
1 parent 862971b commit 67f0100

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@
1313

1414
## Overview
1515

16-
[CodeQL Extractor Action][github] is a GitHub Action that helps none-GitHub [CodeQL] Extractor to integrate with GitHub Actions.
16+
[CodeQL Extractor Action][github] is a GitHub Action that helps [CodeQL] Extractor to integrate with GitHub Actions.
17+
18+
> [!WARNING]
19+
> This action downloads the extractor from the GitHub repository. Make sure to use a trusted repository, owner, and extractor.
1720
1821
## ✨ Features
1922

@@ -29,16 +32,26 @@
2932
with:
3033
# Repository reference (e.g. "owner/repo", "owner/repo@ref")
3134
extractor: "advanced-security/codeql-extractor-iac"
35+
# [optional]: Language(s)
36+
languages: "iac"
3237
# [optional] Attest the authenticity of the extractor
3338
attestation: true
3439
```
3540
36-
> !WARNING
37-
> This action downloads the extractor from the GitHub repository. Make sure to use a trusted repository, owner, and extractor.
41+
## Maintainers / Contributors
42+
43+
- [@GeekMasher](https://github.com/GeekMasher) - Author / Core Maintainer
44+
45+
## Support
46+
47+
Please create [GitHub Issues][github-issues] if there are bugs or feature requests.
48+
49+
This project uses [Sematic Versioning (v2)](https://semver.org/) and with major releases, breaking changes will occur.
3850
3951
## License
4052
41-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
53+
This project is licensed under the terms of the MIT open source license.
54+
Please refer to [MIT][license] for the full terms.
4255
4356
<!-- Resoucres -->
4457

0 commit comments

Comments
 (0)