Skip to content

Commit f09db90

Browse files
committed
refactor: Update package.json and README.md
1 parent 320be45 commit f09db90

File tree

5 files changed

+46
-57
lines changed

5 files changed

+46
-57
lines changed
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
name: Support
3+
about: If you have any questions—whether about unclear features or insufficient documentation—feel free to reach out.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1-
# Change Log
1+
# GitGuardian Secret Security Changelog
22

3-
## [0.0.1]
3+
## [0.1.0]
44

5-
- Initial release
5+
### Added
6+
- One-Click Authentication
7+
- Automatic Secret Scanning on Save
8+
- Custom Remediation Guidelines
9+
- Visibility into Usage Quota

README.md

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,63 @@
1-
# GitGuardian's ggshield VSCode extension
1+
# GitGuardian for VSCode
22

3-
## Table of content
3+
Simply install the extension and let GitGuardian protect you from accidentally exposing secrets in your code. With GitGuardian, you can code with confidence, knowing that your sensitive information is safe from leaks.
44

5-
- [GitGuardian's ggshield VSCode extension](#gitguardians-ggshield-vscode-extension)
6-
- [Table of contents](#table-of-contents)
7-
- [Description](#description)
8-
- [Features](#features)
9-
- [Getting started](#getting-started)
10-
- [Scan for secrets](#scan-for-secrets)
11-
- [How to remediate incidents?](#how-to-remediate-incidents)
12-
- [Ignore secrets (only when working in a workspace)](#ignore-secrets-only-when-working-in-a-workspace)
13-
- [Check my quota](#check-my-quota)
14-
- [Support, Feedback, Contributing](#support-feedback-contributing)
15-
- [Release Notes](#release-notes)
16-
- [License](#license)
17-
18-
## Description
19-
20-
This extension helps you detect more than 400+ types of secrets directly from VSCode using [ggshield](https://www.gitguardian.com/ggshield)) CLI application.
21-
22-
NB: The extension uses the quota of secret detection of your ggshield API token.
5+
We detect more than 400+ types of secrets directly from VSCode using [GitGuardian CLI (ggshield)](https://www.gitguardian.com/ggshield).
236

247
### Features
258

26-
- When a file is saved, it is scanned using the ggshield CLI application
27-
- Found incidents are highlighted in code and available in the `Problems` panel as warnings
28-
- Secrets can be ignored running the command `ggshield: Ignore last found incidents` or via the UI
29-
- The API quota can be checked running the command `ggshield: Show quota`
9+
- When a file is saved, it is scanned using the GitGuardian CLI (ggshield) application bundled with the extension
10+
- Found secrets are highlighted in code and available in the `Problems` panel as warnings
11+
- Secrets can be ignored running the command `gitguardian: Ignore last found incidents` or via the UI
12+
- Your API quota can be checked running the command `gitguardian: Show quota`
3013

3114
![Incident highlighted](./doc/incident_highlighted_dark.png)
3215

3316
## Getting started
3417

18+
### Authentication
19+
20+
Once the extension is installed, simply click on "Link your IDE to your account" for automatic authentication. If you are a user with an on-premise instance of GitGuardian, go to the extension settings to enter your URL and API key.
21+
3522
### Scan for secrets
3623

3724
The scanning is triggered automatically when saving a file. Incidents are highlighted in file and available in the `Problems` panel as warnings.
3825

3926
### How to remediate incidents?
4027

28+
Remediation guidelines are conveniently displayed directly in the extension's side panel. Your security team can customize these messages to provide you with the most accurate information, enabling you to address issues promptly and effectively.
29+
4130
For more info on how to remediate incidents, you can take a look at GitGuardian's [documentation](https://docs.gitguardian.com/internal-repositories-monitoring/remediate/remediate-incidents).
4231

4332
### Ignore secrets (only when working in a workspace)
4433

45-
Right after saving a file if incidents were found run the command `ggshield: Ignore last found incidents`.
46-
This will create and fill the ggshield file `.gitguardian.yaml` at the root of the workspace and ignore the secrets found. See ggshield's [documentation](https://docs.gitguardian.com/ggshield-docs/reference/secret/ignore) for info.
34+
Immediately after saving a file, if any incidents are detected, you can hover over the identified secret and click on "GitGuardian: Ignore Secret."
35+
36+
This action will create or update the .gitguardian.yaml file in the root of your workspace, allowing you to ignore the detected secrets.
37+
38+
For more information, please refer to the GitGuardian CLI (ggshield) documentation.
4739

4840
### Check my quota
4941

50-
Run the command `ggshield: Show quota` from VSCode command palette to check the current status of your API quota.
42+
Run the command `gitguardian: Show quota` from VSCode command palette to check the current status of your API quota.
43+
44+
With a free personal account, you have access to 10,000 API calls each month.
5145

5246
## Support, Feedback, Contributing
5347

54-
This project is open to feature requests/suggestions, bug reports etc. via GitHub issues. Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines.
48+
This project is open to feature requests/suggestions, bug reports etc.
49+
50+
If you need support or found a bug : https://github.com/GitGuardian/gitguardian-vscode/issues/new/choose
51+
52+
For ideas and general discussions : https://github.com/GitGuardian/gitguardian-vscode/discussions
53+
54+
Security reports : Please report it using our [Vulnerability Disclosure Portal](https://vdp.gitguardian.com).
55+
5556

5657
## Release Notes
5758

5859
See [Change log](./CHANGELOG.md)
5960

6061
## License
6162

62-
ggshield and this extension are MIT licensed.
63+
GitGuardian CLI (ggshield) and this extension are MIT licensed.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"description": "Visual Studio Code extension designed to help developers safeguard their sensitive information from accidental leaks in their code",
66
"icon": "images/icon.png",
77
"version": "0.1.0",
8-
"publisher": "GitGuardian",
8+
"publisher": "GitGuardian ",
99
"engines": {
1010
"vscode": "^1.81.0"
1111
},

0 commit comments

Comments
 (0)