Skip to content

Commit 23a2624

Browse files
committed
Readme: Outline structure
1 parent 0c9ea97 commit 23a2624

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,26 @@
66
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fapple%2Fswift-container-plugin%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/apple/swift-container-plugin)
77
[![](https://github.com/apple/swift-container-plugin/actions/workflows/main.yml/badge.svg)](https://github.com/apple/swift-container-plugin/actions/workflows/main.yml)
88

9-
Publish container images using Swift Package Manager.
9+
Build and publish container images using Swift Package Manager.
10+
11+
## Overview
12+
13+
Container images are the standard way to package cloud software today. Once you have packaged your server in a container image, you can deploy it on any container-based public or private cloud service, or run it locally using a desktop container runtime.
14+
15+
Swift Container Plugin provides a Swift Package Manager command plugin and utilities to make it easy to build container images for servers written in Swift.
1016

1117
Find out about Swift Container Plugin and see it in action:
1218

1319
* [How to put Swift in a box](https://fosdem.org/2025/schedule/event/fosdem-2025-5116-how-to-put-swift-in-a-box-building-container-images-with-swift-container-plugin/) at [FOSDEM 2025](https://fosdem.org/2025/schedule/track/swift/).
1420
* [Swift to the cloud in a single step](https://www.youtube.com/watch?v=9AaINsCfZzw) at [ServerSide.Swift 2024](https://www.serversideswift.info/speakers/euan-harris/).
1521

16-
## Overview
22+
## Usage
1723

18-
Swift Container Plugin provides a Swift Package Manager command plugin and utilities to make it easy to build container images for servers written in Swift.
24+
Swift Container Plugin can package any executable product defined in `Package.swift` in a container image and publish it to a container registry.
1925

20-
> Container images are the standard way to package cloud software today. Once you have packaged your server in a container image, you can deploy it on any container-based public or private cloud service, or run it locally using a desktop container runtime.
26+
### Build and publish a container image
2127

22-
After setting up your project, you can use the plugin to build and publish a container image in one step:
28+
After adding the plugin to your project, you can use it to build and publish a container image in one step:
2329

2430
```
2531
% swift package --swift-sdk x86_64-swift-linux-musl \
@@ -44,7 +50,9 @@ Build of product 'hello-world' complete! (5.51s)
4450
registry.example.com/myservice@sha256:a3f75d0932d052dd9d448a1c9040b16f9f2c2ed9190317147dee95a218faf1df
4551
```
4652

47-
You can then use a container runtime, such as `podman` to run the image:
53+
### Run the image
54+
55+
You can deploy your service in the cloud, or use a standards-compliant container runtime such as `podman` to run the image locally:
4856

4957
```
5058
% podman run -p 8080:8080 registry.example.com/myservice@sha256:a3f75d0932d052dd9d448a1c9040b16f9f2c2ed9190317147dee95a218faf1df

0 commit comments

Comments
 (0)