Merge branch 'main' into dependabot/github_actions/production-dependencies-e858884d56

Author: GeekMasher

.release.yml

@@ -0,0 +1,2 @@
+name: "ghastoolkit"
+version: "0.12.4"

Pipfile

@@ -33,4 +33,3 @@ lint = "black --check ./src/ghastoolkit"
 # docs
 docs = "sphinx-build -b html ./docs ./public"
 docs-check = "sphinx-build -b html ./docs ./public -W"
-#

Pipfile.lock

@@ -1,22 +1,35 @@
+<!-- markdownlint-disable -->
 <div align="center">
 <h1>GHASToolkit</h1>
 <img src="https://raw.githubusercontent.com/GeekMasher/ghastoolkit/main/docs/static/ghastoolkit.png" />
 
-[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/GeekMasher/ghastoolkit)
-[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/geekmasher/ghastoolkit/python-package.yml?style=for-the-badge)](https://github.com/GeekMasher/ghastoolkit/actions/workflows/python-package.yml?query=branch%3Amain)
-[![GitHub Issues](https://img.shields.io/github/issues/geekmasher/ghastoolkit?style=for-the-badge)](https://github.com/GeekMasher/ghastoolkit/issues)
-[![GitHub Stars](https://img.shields.io/github/stars/geekmasher/ghastoolkit?style=for-the-badge)](https://github.com/GeekMasher/ghastoolkit)
-[![Python Versions](https://img.shields.io/pypi/pyversions/ghastoolkit?style=for-the-badge)](https://pypi.org/project/ghastoolkit/)
-[![Licence](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)](./LICENSE)
+[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)][github]
+[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/geekmasher/ghastoolkit/python-package.yml?style=for-the-badge)][github]
+[![GitHub Issues](https://img.shields.io/github/issues/geekmasher/ghastoolkit?style=for-the-badge)][github-issues]
+[![GitHub Stars](https://img.shields.io/github/stars/geekmasher/ghastoolkit?style=for-the-badge)][github]
+[![Python Versions](https://img.shields.io/pypi/pyversions/ghastoolkit?style=for-the-badge)][pypi]
+[![License](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)][license]
 
 </div>
+<!-- markdownlint-restore -->
 
 ## Overview
 
-[GitHub Advanced Security (GHAS)](https://github.com/features/security) Python Toolkit to make the lives of everyone that uses GHAS a little easier.
+[GitHub Advanced Security (GHAS)][advanced-security] Python Toolkit to make the lives of everyone that uses GHAS a little easier.
 
+## ✨ Features
 
-## Installing
+- API Client for all GHAS Features
+  - Code Scanning
+  - Secret Scanning
+  - Dependency Graph
+  - Security Advisories
+  - Dependabot / Security Alerts
+- CodeQL Management
+  - Database Management
+  - Packs / Query Management
+
+## 📦 Installing
 
 To install `ghastoolkit`, you can use `pip` or one of `pypi` family's of tools to install:
 
@@ -31,18 +44,40 @@ pipenv install ghastoolkit
 poetry add ghastoolkit
 ```
 
-## Usage
+## 🏃 Usage
+
+To see how to use `ghastoolkit`, [take a look at the docs][docs].
+
+## 🧑‍🤝‍🧑 Maintainers / Contributors
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+## 🦸 Support
 
-To see how to use `ghastoolkit`, [take a look at the docs](https://geekmasher.github.io/ghastoolkit).
+Please create [GitHub Issues][github-issues] if there are bugs or feature requests.
 
+This project uses [Semantic Versioning (v2)][semver] and with major releases, breaking changes will occur.
 
-## Licence
+## 📓 License
 
 This project is licensed under the terms of the MIT open source license.
-Please refer to [MIT](./LICENSE.md) for the full terms.
+Please refer to [MIT][license] for the full terms.
 
+<!-- Resources -->
 
-## Support
+[license]: ./LICENSE
+[pypi]: https://pypi.org/project/ghastoolkit
+[github]: https://github.com/GeekMasher/ghastoolkit
+[github-issues]: https://github.com/GeekMasher/ghastoolkit/issues
 
-Support is via [GitHub Issues](https://github.com/GeekMasher/ghastoolkit/issues)
+[docs]: https://geekmasher.github.io/ghastoolkit
+[advanced-security]: https://github.com/features/security
 
+[semver]: https://semver.org/