Skip to content

Commit 35eb2db

Browse files
committed
docs: Update README
1 parent 2791863 commit 35eb2db

File tree

1 file changed

+49
-14
lines changed

1 file changed

+49
-14
lines changed

README.md

Lines changed: 49 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,35 @@
1+
<!-- markdownlint-disable -->
12
<div align="center">
23
<h1>GHASToolkit</h1>
34
<img src="https://raw.githubusercontent.com/GeekMasher/ghastoolkit/main/docs/static/ghastoolkit.png" />
45

5-
[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/GeekMasher/ghastoolkit)
6-
[![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)
7-
[![GitHub Issues](https://img.shields.io/github/issues/geekmasher/ghastoolkit?style=for-the-badge)](https://github.com/GeekMasher/ghastoolkit/issues)
8-
[![GitHub Stars](https://img.shields.io/github/stars/geekmasher/ghastoolkit?style=for-the-badge)](https://github.com/GeekMasher/ghastoolkit)
9-
[![Python Versions](https://img.shields.io/pypi/pyversions/ghastoolkit?style=for-the-badge)](https://pypi.org/project/ghastoolkit/)
10-
[![Licence](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)](./LICENSE)
6+
[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)][github]
7+
[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/geekmasher/ghastoolkit/python-package.yml?style=for-the-badge)][github]
8+
[![GitHub Issues](https://img.shields.io/github/issues/geekmasher/ghastoolkit?style=for-the-badge)][github-issues]
9+
[![GitHub Stars](https://img.shields.io/github/stars/geekmasher/ghastoolkit?style=for-the-badge)][github]
10+
[![Python Versions](https://img.shields.io/pypi/pyversions/ghastoolkit?style=for-the-badge)][pypi]
11+
[![License](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)][license]
1112

1213
</div>
14+
<!-- markdownlint-restore -->
1315

1416
## Overview
1517

16-
[GitHub Advanced Security (GHAS)](https://github.com/features/security) Python Toolkit to make the lives of everyone that uses GHAS a little easier.
18+
[GitHub Advanced Security (GHAS)][advanced-security] Python Toolkit to make the lives of everyone that uses GHAS a little easier.
1719

20+
## ✨ Features
1821

19-
## Installing
22+
- API Client for all GHAS Features
23+
- Code Scanning
24+
- Secret Scanning
25+
- Dependency Graph
26+
- Security Advisories
27+
- Dependabot / Security Alerts
28+
- CodeQL Management
29+
- Database Management
30+
- Packs / Query Management
31+
32+
## 📦 Installing
2033

2134
To install `ghastoolkit`, you can use `pip` or one of `pypi` family's of tools to install:
2235

@@ -31,18 +44,40 @@ pipenv install ghastoolkit
3144
poetry add ghastoolkit
3245
```
3346

34-
## Usage
47+
## 🏃 Usage
48+
49+
To see how to use `ghastoolkit`, [take a look at the docs][docs].
50+
51+
## 🧑‍🤝‍🧑 Maintainers / Contributors
52+
53+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
54+
<!-- prettier-ignore-start -->
55+
<!-- markdownlint-disable -->
56+
57+
<!-- markdownlint-restore -->
58+
<!-- prettier-ignore-end -->
59+
60+
<!-- ALL-CONTRIBUTORS-LIST:END -->
61+
62+
## 🦸 Support
3563

36-
To see how to use `ghastoolkit`, [take a look at the docs](https://geekmasher.github.io/ghastoolkit).
64+
Please create [GitHub Issues][github-issues] if there are bugs or feature requests.
3765

66+
This project uses [Semantic Versioning (v2)][semver] and with major releases, breaking changes will occur.
3867

39-
## Licence
68+
## 📓 License
4069

4170
This project is licensed under the terms of the MIT open source license.
42-
Please refer to [MIT](./LICENSE.md) for the full terms.
71+
Please refer to [MIT][license] for the full terms.
4372

73+
<!-- Resources -->
4474

45-
## Support
75+
[license]: ./LICENSE
76+
[pypi]: https://pypi.org/project/ghastoolkit
77+
[github]: https://github.com/GeekMasher/ghastoolkit
78+
[github-issues]: https://github.com/GeekMasher/ghastoolkit/issues
4679

47-
Support is via [GitHub Issues](https://github.com/GeekMasher/ghastoolkit/issues)
80+
[docs]: https://geekmasher.github.io/ghastoolkit
81+
[advanced-security]: https://github.com/features/security
4882

83+
[semver]: https://semver.org/

0 commit comments

Comments
 (0)