Skip to content

Commit bc52328

Browse files
authored
Merge pull request #1 from segraef/yufviuob
docs: update README for improved clarity on installation and usage
2 parents 59458e0 + 13e38d2 commit bc52328

1 file changed

Lines changed: 7 additions & 28 deletions

File tree

README.md

Lines changed: 7 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -10,38 +10,17 @@
1010
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-green" alt="License"></a>
1111
</p>
1212

13-
## Quick start
14-
15-
Clone, then run it - `seckit install` sets up the scanners for you.
16-
17-
**macOS / Linux**
13+
## Run it
1814

1915
```bash
2016
git clone https://github.com/segraef/sec-kit.git && cd sec-kit
21-
bash seckit.sh install # installs scanners via Homebrew + npm
22-
bash seckit.sh # interactive menu
23-
```
24-
25-
**Windows (PowerShell)**
26-
27-
```powershell
28-
git clone https://github.com/segraef/sec-kit.git; cd sec-kit
29-
pwsh ./seckit.ps1 install # installs scanners via scoop + pipx + npm
30-
pwsh ./seckit.ps1 # interactive menu
17+
bash seckit.sh # macOS / Linux
18+
pwsh ./seckit.ps1 # Windows
3119
```
3220

33-
Optional: `ln -s "$PWD/seckit.sh" /usr/local/bin/seckit` so you can just type `seckit`.
34-
35-
## Commands
21+
That opens a menu. Pick **2) install** the first time — SecKit installs the
22+
scanners for you. Then **3) scan** a folder, or **4) harden** a repo against
23+
Claude/Copilot.
3624

37-
```
38-
seckit interactive menu (no arguments)
39-
seckit doctor check the scanners are installed
40-
seckit scan [DIR] scan repos for vuln deps, code/IaC flaws, malware, secrets
41-
seckit harden [DIR] add Claude + Copilot guardrails (--global for machine-wide)
42-
seckit reminders show all reminders
43-
seckit startup banner + rotating reminder + scanner health (for your shell rc)
44-
```
25+
More: [`docs/`](docs/) · [`CONTRIBUTING.md`](CONTRIBUTING.md) · [`LICENSE`](LICENSE)
4526

46-
Full documentation in [`docs/`](docs/). Bash and PowerShell are equivalent
47-
(`harden` is Bash-only for now). Licensed under [`LICENSE`](LICENSE).

0 commit comments

Comments
 (0)