Skip to content

Commit 142a5f5

Browse files
committed
feat: Update README with installation instructions and showcase images
1 parent 9a02e07 commit 142a5f5

File tree

4 files changed

+45
-14
lines changed

4 files changed

+45
-14
lines changed

README.md

Lines changed: 45 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,41 @@ Seamlessly integrate GitHub's powerful CodeQL scanning engine directly into your
3030

3131
## 🚀 Getting Started
3232

33-
1. Install the extension from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=codeql-scanner.codeql-scanner-vscode)
33+
1. Install the extension from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=GeekMasher.codeql-scanner-vscode)
3434
2. Configure your GitHub token (optional for enhanced features)
3535
3. Open any code repository
3636
4. Run a scan using the command palette (`Ctrl+Shift+P` or `Cmd+Shift+P`): `CodeQL: Run Scan`
3737

38+
## 📸 Showcase
39+
40+
Here are some screenshots showcasing the extension's capabilities:
41+
42+
<!-- markdownlint-disable -->
43+
<details>
44+
<summary>CodeQL Scanner Scan and Alert Summary</summary>
45+
46+
<div align="center">
47+
<img src="./assets/showcase-scan-summary.png" title="CodeQL Scanner Scan and Alert Summary">
48+
</div>
49+
</details>
50+
51+
<details>
52+
<summary>CodeQL Scanner Configuration Menu / Settings</summary>
53+
54+
<div align="center">
55+
<img src="./assets/showcase-configuration.png" title="CodeQL Scanner Configuration Menu">
56+
</div>
57+
</details>
58+
59+
<details>
60+
<summary>CodeQL Scanner Results Tree Viewer</summary>
61+
62+
<div align="center">
63+
<img src="./assets/showcase-results.png" title="CodeQL Scanner Results Tree Viewer">
64+
</div>
65+
</details>
66+
67+
3868
## 📋 Prerequisites
3969

4070
- **CodeQL CLI**: The extension requires the [CodeQL CLI](https://github.com/github/codeql-cli-binaries/releases) to be installed and available on your system PATH
@@ -49,26 +79,26 @@ Seamlessly integrate GitHub's powerful CodeQL scanning engine directly into your
4979

5080
## 📋 Available Commands
5181

52-
| Command | Description |
53-
|---------|-------------|
54-
| `CodeQL: Run Scan` | Start a security scan on the current workspace |
55-
| `CodeQL: Initialize Repository` | Set up CodeQL for the current repository |
56-
| `CodeQL: Run Analysis` | Execute a full code analysis |
57-
| `CodeQL: Configure Settings` | Open the extension settings |
58-
| `CodeQL: Show Logs` | View the extension's log output |
59-
| `CodeQL: Clear Logs` | Clear all log entries |
60-
| `CodeQL: Clear Inline Diagnostics` | Remove inline problem markers |
61-
| `CodeQL: Show CLI Information` | Display information about the CodeQL CLI |
62-
| `CodeQL: Copy Flow Path` | Copy vulnerability data flow path to clipboard |
63-
| `CodeQL: Navigate Flow Steps` | Step through vulnerability data flow paths |
82+
| Command | Description |
83+
| ---------------------------------- | ---------------------------------------------- |
84+
| `CodeQL: Run Scan` | Start a security scan on the current workspace |
85+
| `CodeQL: Initialize Repository` | Set up CodeQL for the current repository |
86+
| `CodeQL: Run Analysis` | Execute a full code analysis |
87+
| `CodeQL: Configure Settings` | Open the extension settings |
88+
| `CodeQL: Show Logs` | View the extension's log output |
89+
| `CodeQL: Clear Logs` | Clear all log entries |
90+
| `CodeQL: Clear Inline Diagnostics` | Remove inline problem markers |
91+
| `CodeQL: Show CLI Information` | Display information about the CodeQL CLI |
92+
| `CodeQL: Copy Flow Path` | Copy vulnerability data flow path to clipboard |
93+
| `CodeQL: Navigate Flow Steps` | Step through vulnerability data flow paths |
6494

6595
## ⚙️ Configuration Options
6696

6797
The extension provides several configuration options to customize its behavior:
6898

6999
```json
70100
{
71-
"codeql-scanner.github.token": "your-github-token",
101+
"codeql-scanner.github.token": "your-github-token"
72102
}
73103
```
74104

@@ -84,6 +114,7 @@ CodeQL is GitHub's semantic code analysis engine that lets you query code as if
84114
## 🔗 Integration with GitHub
85115

86116
Connect the extension to GitHub for enhanced capabilities:
117+
87118
- Access GitHub's vast CodeQL query library
88119
- Synchronize with your GitHub repositories
89120
- View and manage GitHub code scanning alerts

assets/showcase-configuration.png

741 KB
Loading

assets/showcase-results.png

562 KB
Loading

assets/showcase-scan-summary.png

872 KB
Loading

0 commit comments

Comments
 (0)