Skip to content

Commit 5b31bac

Browse files
committed
Updated readme
1 parent 9964f28 commit 5b31bac

File tree

4 files changed

+8
-10
lines changed

4 files changed

+8
-10
lines changed

.hooks/version-check.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ def main():
104104

105105
# Ensure versions are synced
106106
current_version = check_version_sync()
107-
previous_version = read_version_from_git("src/version.py")
107+
previous_version = read_version_from_git("socket_basics/version.py")
108108

109109
print(f"Current: {current_version}, Previous: {previous_version}")
110110

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Security Wrapper — socket-basics
1+
# Socket Basics
22

3-
Security Wrapper is a small, extensible CLI tool that orchestrates multiple security scanners (SAST, secret scanning, container scanning), normalizes their outputs into a single consolidated Socket facts JSON format, and delivers results to configured notifiers (console, Slack, Jira, webhooks, Sumo Logic, MS Sentinel, etc.).
3+
Socket Basics is a small, extensible CLI tool that orchestrates multiple security scanners (SAST, secret scanning, container scanning), normalizes their outputs into a single consolidated Socket facts JSON format, and delivers results to configured notifiers (console, Slack, Jira, webhooks, Sumo Logic, MS Sentinel, etc.).
44

55
This README is a first-time, clean-slate guide to installing, running, configuring, and extending the tool.
66

@@ -22,7 +22,7 @@ This README is a first-time, clean-slate guide to installing, running, configuri
2222

2323
## Overview
2424

25-
Security Wrapper provides:
25+
Socket Basics provides:
2626

2727
- A unified CLI: `socket-basics`
2828
- A plugin-style connector system for integrating scanners (OpenGrep, Trivy, TruffleHog, etc.)
@@ -87,13 +87,11 @@ INPUT_CONSOLE_ENABLED=true
8787
INPUT_SOCKET_CONSOLE_MODE=tabular
8888
```
8989

90-
3) Run the container mounting the current directory into `/workspace` and pass the CLI flags you provided. This example runs secrets scanning, JavaScript SAST, requests Socket tier1 reporting, and scans the `trickyhu/sigsci-rule-editor` container image:
90+
3) Run the container mounting the current directory into `/workspace` and pass the CLI flags you provided. As long as it is a git repo it'll automatically pick up the repo and branch information for the scan. This example runs secrets scanning, JavaScript SAST, requests Socket tier1 reporting, and scans the `trickyhu/sigsci-rule-editor` container image:
9191

9292
```sh
9393
docker run --rm -v "$PWD:/workspace" --env-file .env socket-basics \
9494
--workspace /workspace \
95-
--repo node_goat_17 \
96-
--branch main \
9795
--secrets \
9896
--console-tabular-enabled \
9997
--javascript \
@@ -360,7 +358,7 @@ jobs:
360358
runs-on: ubuntu-latest
361359
steps:
362360
- uses: actions/checkout@v4
363-
- name: Run security wrapper
361+
- name: Run Socket Basics
364362
uses: ./ # when running from the same repo; replace with org/repo@vX for published action
365363
with:
366364
github_token: ${{ secrets.GITHUB_TOKEN }}

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "socket-basics"
3-
version = "1.0.0"
3+
version = "1.0.1"
44
description = "Socket Basics with integrated SAST, secret scanning, and container analysis"
55
readme = "README.md"
66
requires-python = ">=3.10"

socket_basics/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "1.0.0"
1+
__version__ = "1.0.1"

0 commit comments

Comments
 (0)