Skip to content

Examples: Add READMEs #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+23 −0
Open

Examples: Add READMEs #92

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions Examples/HelloWorldWithResources/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# HelloWorldWithResources

This example shows you how to use a resource bundle in your service. It builds a Hummingbird server which returns a randomly-selected image from its resource bundle.

1. [Install a Static Linux SDK](Sources/ContainerImageBuilderPluginDocumentation/Documentation.docc/ContainerImageBuilderPlugin.md#install-a-swift-sdk-for-cross-compilation-on-macos) for your Swift compiler. For instance, this command installs the Static Linux SDK for Swift 6.1:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since I expect the readme will be viewed within the context of looking at this site on GitHub (or perhaps locally), this might be better as a full https:// link to the host documentation content (guessing SwiftPackageIndex would make the most sense, but possibly GitHub pages if your project is leaning in that direction for some reason)

```
% swift sdk install https://download.swift.org/swift-6.1-release/static-sdk/swift-6.1-RELEASE/swift-6.1-RELEASE_static-linux-0.0.1.artifactbundle.tar.gz \
--checksum 111c6f7d280a651208b8c74c0521dd99365d785c1976a6e23162f55f65379ac6
```

2. Build the service and upload it to a container registry:
```
% swift package --swift-sdk aarch64-swift-linux-musl \
--allow-network-connections all build-container-image \
--repository registry.example.com/resources
```

3. Run the service:
```
% podman run -it --rm -p 8080:8080 registry.example.com/resources
```

4. Access the service [from your browser](localhost:8080/). It should return a random emoji chosen from the three images stored in the bundle.