Skip to content

Commit c5b1809

Browse files
committed
Reorganize Quick Start: clearly separate pre-built image vs build from source
1 parent b91e38f commit c5b1809

1 file changed

Lines changed: 23 additions & 20 deletions

File tree

README.md

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,19 @@ SimpleSecCheck is a powerful, single-shot Docker-based security scanner that per
7373
- Docker and Docker Compose
7474
- Target codebase or web application to scan
7575

76-
### Easy Usage
76+
### Quick Start (Pre-built Image - Recommended)
77+
78+
**Option 1: Using Pre-built Image from Docker Hub** ⭐ Recommended
7779

7880
```bash
7981
# Clone the repository
8082
git clone https://github.com/fr4iser90/SimpleSecCheck.git
8183
cd SimpleSecCheck
8284

83-
# Make the script executable (one-time setup)
85+
# Pull the pre-built image
86+
docker pull fr4iser/simpleseccheck:latest
87+
88+
# Make the script executable
8489
chmod +x run-docker.sh
8590

8691
# Scan a local code project
@@ -90,6 +95,20 @@ chmod +x run-docker.sh
9095
./run-docker.sh https://example.com
9196
```
9297

98+
**Option 2: Build from Source**
99+
100+
```bash
101+
# Clone the repository
102+
git clone https://github.com/fr4iser90/SimpleSecCheck.git
103+
cd SimpleSecCheck
104+
105+
# Make the script executable
106+
chmod +x run-docker.sh
107+
108+
# The script will automatically build the Docker image on first run
109+
./run-docker.sh /path/to/your/project
110+
```
111+
93112
That's it! Results will be available in the `results/` directory.
94113

95114
### Scan Examples
@@ -251,24 +270,10 @@ echo " patterns:" >> rules/custom.yml
251270
echo " - pattern: dangerous_function(...)" >> rules/custom.yml
252271
```
253272

254-
### Using Pre-built Docker Image
255-
256-
You can pull the pre-built image from Docker Hub and use it directly without cloning the repository:
257-
258-
**Option 1: Using the wrapper script (Recommended)**
259-
```bash
260-
# Clone the repository for the wrapper script
261-
git clone https://github.com/fr4iser90/SimpleSecCheck.git
262-
cd SimpleSecCheck
263-
264-
# Pull the pre-built image instead of building
265-
docker pull fr4iser/simpleseccheck:latest
273+
### Using Docker Directly (Advanced)
266274

267-
# Use the wrapper script with the pre-built image
268-
./run-docker.sh /path/to/your/project
269-
```
275+
For advanced users who want to use Docker directly without the wrapper script:
270276

271-
**Option 2: Using Docker directly (Advanced)**
272277
```bash
273278
# Pull the latest image
274279
docker pull fr4iser/simpleseccheck:latest
@@ -291,8 +296,6 @@ docker run --rm \
291296
/SimpleSecCheck/scripts/security-check.sh
292297
```
293298

294-
**Note:** The pre-built image contains all necessary configurations. Option 1 is recommended as it handles all volume mounts and environment variables automatically.
295-
296299
### Direct Docker Compose Usage
297300

298301
For advanced users who want more control:

0 commit comments

Comments
 (0)