Skip to content

Commit faae908

Browse files
J Guerreiroericfourrier
andauthored
fix(doc): add API introduction to README (#2)
* fix(doc): add API introduction to README Co-authored-by: Eric Fourrier <[email protected]>
1 parent f7219e5 commit faae908

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@
77
[![GitHub stars](https://img.shields.io/github/stars/GitGuardian/py-gitguardian)](https://github.com/GitGuardian/py-gitguardian/stargazers)
88
[![CodeFactor](https://www.codefactor.io/repository/github/gitguardian/py-gitguardian/badge)](https://www.codefactor.io/repository/github/gitguardian/py-gitguardian)
99

10-
API client library for the GitGuardian API.
10+
API client library for the [GitGuardian API](https://api.gitguardian.com/).
11+
12+
The GitGuardian API puts at your fingertips the power to detect more than 200 types of secrets in any text content, as well as other potential security vulnerabilities.
13+
14+
**py-gitguardian** can be used to create integrations to scan various data sources, from your workstation's filesystem to your favorite chat application.
1115

1216
You can check API details [here](https://api.gitguardian.com/docs)
1317
with all the response codes and expected structures on each method.

0 commit comments

Comments
 (0)