Skip to content

Commit b4fbe67

Browse files
committed
Rewrite README audience sections with specific use cases and rationale
1 parent 6ee3550 commit b4fbe67

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -53,18 +53,15 @@ When you run `RUN npm install` or `RUN apt-get install` in a Dockerfile, these c
5353

5454
### Recommended for:
5555

56-
- Teams building Docker images in CI/CD environments
57-
- Organizations with security compliance requirements (SOC 2, ISO 27001, etc.)
58-
- Projects using public package registries (npm, PyPI, RubyGems, etc.)
59-
- Anyone concerned about supply chain security
60-
- Companies handling sensitive data or intellectual property
56+
- **CI/CD pipelines pulling from public registries** — if your builds download packages from npm, PyPI, RubyGems, or other public sources, buildcage limits the blast radius of compromised packages
57+
- **Builds that handle secrets** — if your Dockerfiles use build secrets, tokens, or credentials, buildcage prevents them from being exfiltrated to unauthorized servers
58+
- **Teams that need network visibility** — if you need to know exactly which external services your builds contact, buildcage logs every outbound connection and can enforce an allowlist
6159

6260
### May not be necessary for:
6361

64-
- Builds that already run in completely offline environments
65-
- Teams using only vetted, internal package repositories
66-
- Simple static site builds with no external dependencies
67-
- Projects where build speed is critical and security is less of a concern
62+
- **Fully offline builds** — if your builds run in an air-gapped environment with no external network access
63+
- **Internal-only registries** — if all dependencies come from vetted, internal repositories with no public package sources
64+
- **No-dependency builds** — if your Dockerfile only copies files and never runs commands that fetch external resources
6865

6966
## Features
7067

@@ -80,8 +77,8 @@ When you run `RUN npm install` or `RUN apt-get install` in a Dockerfile, these c
8077
### Prerequisites
8178

8279
- Docker with BuildKit (buildx plugin)
83-
- Docker Compose (for local usage)
8480
- GitHub Actions runner with Docker support (for CI/CD usage)
81+
- Docker Compose (for local usage)
8582

8683
### First-Time Setup (Recommended Workflow)
8784

0 commit comments

Comments
 (0)