Skip to content

Commit 8cb75a8

Browse files
committed
docs: Update README and add contributors
1 parent c8d2e15 commit 8cb75a8

File tree

2 files changed

+89
-2
lines changed

2 files changed

+89
-2
lines changed

.all-contributorsrc

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"repoType": "github",
3+
"repoHost": "https://github.com",
4+
"projectName": "codeql-extractor-bicep",
5+
"projectOwner": "GitHubSecurityLab",
6+
"files": [
7+
"README.md"
8+
],
9+
"imageSize": 100,
10+
"contributorsPerLine": 10,
11+
"commitConvention": "gitmoji",
12+
"skipCi": true,
13+
"contributors": [
14+
{
15+
"login": "geekmasher",
16+
"name": "Mathew Payne",
17+
"avatar_url": "https://avatars.githubusercontent.com/u/2772944?v=3",
18+
"profile": "https://geekmasher.dev",
19+
"contributions": [
20+
"code",
21+
"research",
22+
"maintenance",
23+
"security",
24+
"ideas"
25+
]
26+
}
27+
]
28+
}

README.md

Lines changed: 61 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,61 @@
1-
# codeql-extractor-bicep
2-
CodeQL Extractor for Bicep Configurations
1+
<!-- markdownlint-disable -->
2+
<div align="center">
3+
4+
<h1>CodeQL Bicep Extractor</h1>
5+
6+
[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/GitHubSecurityLab/codeql-extractor-bicep)
7+
[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/GitHubSecurityLab/codeql-extractor-bicep/publish.yml?style=for-the-badge)](https://github.com/GitHubSecurityLab/codeql-extractor-bicep/actions/workflows/publish.yml?query=branch%3Amain)
8+
[![GitHub Issues](https://img.shields.io/github/issues/GitHubSecurityLab/codeql-extractor-bicep?style=for-the-badge)](https://github.com/GitHubSecurityLab/codeql-extractor-bicep/issues)
9+
[![GitHub Stars](https://img.shields.io/github/stars/GitHubSecurityLab/codeql-extractor-bicep?style=for-the-badge)](https://github.com/GitHubSecurityLab/codeql-extractor-bicep)
10+
[![License](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)](./LICENSE)
11+
12+
</div>
13+
<!-- markdownlint-restore -->
14+
15+
[CodeQL][codeql] Extractor, Library, and Queries for Bicep configuations.
16+
17+
## Usage
18+
19+
```yaml
20+
- name: Initialize and Analyze Bicep
21+
uses: GitHubSecurityLab/[email protected]
22+
```
23+
24+
## License
25+
26+
This project is licensed under the terms of the MIT open source license.
27+
Please refer to [MIT](./LICENSE.md) for the full terms.
28+
29+
To use this project for Infrastructure as Code, you will need to [use CodeQL][codeql] and follow all terms and conditions of the [CodeQL License][codeql-license].
30+
31+
For use in private repositories and code, you will need to [purchase a GitHub Advanced Security license][advanced-security].
32+
33+
## Contributors
34+
35+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
36+
<!-- prettier-ignore-start -->
37+
<!-- markdownlint-disable -->
38+
<table>
39+
<tbody>
40+
<tr>
41+
<td align="center" valign="top" width="10%"><a href="https://geekmasher.dev"><img src="https://avatars.githubusercontent.com/u/2772944?v=3?s=100" width="100px;" alt="Mathew Payne"/><br /><sub><b>Mathew Payne</b></sub></a><br /><a href="https://github.com/GitHubSecurityLab/codeql-extractor-bicep/commits?author=geekmasher" title="Code">💻</a> <a href="#research-geekmasher" title="Research">🔬</a> <a href="#maintenance-geekmasher" title="Maintenance">🚧</a> <a href="#security-geekmasher" title="Security">🛡️</a> <a href="#ideas-geekmasher" title="Ideas, Planning, & Feedback">🤔</a></td>
42+
</tr>
43+
</tbody>
44+
</table>
45+
46+
<!-- markdownlint-restore -->
47+
<!-- prettier-ignore-end -->
48+
49+
<!-- ALL-CONTRIBUTORS-LIST:END -->
50+
51+
## Support
52+
53+
Support is via [GitHub Issues][issues] or [GitHub Discussions][discussions].
54+
55+
<!-- Resources -->
56+
57+
[issues]: https://github.com/GitHubSecurityLab/codeql-extractor-bicep/issues
58+
[discussions]: https://github.com/GitHubSecurityLab/codeql-extractor-bicep/discussions
59+
[codeql]: https://codeql.github.com/
60+
[codeql-license]: https://github.com/github/codeql-cli-binaries/blob/main/LICENSE.md
61+
[advanced-security]: https://github.com/features/security

0 commit comments

Comments
 (0)