mirror of
https://github.com/imjasonh/krust
synced 2026-07-18 15:06:03 +00:00
Simplify usage instructions in README.md
Removed sections on building in specific directories and overriding image names for clarity.
This commit is contained in:
parent
f253f841fd
commit
02a8bb007f
1 changed files with 1 additions and 25 deletions
26
README.md
26
README.md
|
|
@ -86,7 +86,7 @@ Note: krust builds fully static binaries by default using musl libc, ensuring ma
|
||||||
|
|
||||||
krust outputs the pushed image reference by digest to stdout, with all other output going to stderr. This enables composability with other tools.
|
krust outputs the pushed image reference by digest to stdout, with all other output going to stderr. This enables composability with other tools.
|
||||||
|
|
||||||
### Build a project in the current directory
|
### Build a project
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Set your repository prefix
|
# Set your repository prefix
|
||||||
|
|
@ -100,11 +100,7 @@ krust build --no-push
|
||||||
|
|
||||||
# Build, push, and run immediately
|
# Build, push, and run immediately
|
||||||
docker run $(krust build)
|
docker run $(krust build)
|
||||||
```
|
|
||||||
|
|
||||||
### Build a specific directory
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Build and push a specific project
|
# Build and push a specific project
|
||||||
krust build path/to/rust/project
|
krust build path/to/rust/project
|
||||||
|
|
||||||
|
|
@ -112,26 +108,6 @@ krust build path/to/rust/project
|
||||||
krust build example/hello-krust --no-push
|
krust build example/hello-krust --no-push
|
||||||
```
|
```
|
||||||
|
|
||||||
### Override the image name
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Use a specific image name (overrides KRUST_REPO)
|
|
||||||
krust build --image myregistry.io/myapp:v1.0
|
|
||||||
|
|
||||||
# Build for a specific platform
|
|
||||||
krust build --platform linux/arm64
|
|
||||||
|
|
||||||
# Build for multiple platforms (multi-arch)
|
|
||||||
krust build --platform linux/amd64,linux/arm64
|
|
||||||
|
|
||||||
# Or specify platforms separately
|
|
||||||
krust build --platform linux/amd64 --platform linux/arm64
|
|
||||||
|
|
||||||
# Default behavior detects platforms from base image
|
|
||||||
# If the base image supports multiple platforms, krust will build for all of them
|
|
||||||
krust build
|
|
||||||
```
|
|
||||||
|
|
||||||
### Build with custom cargo arguments
|
### Build with custom cargo arguments
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue