Skip to content

Commit 5d06917

Browse files
committed
add top level readme
1 parent 34bdced commit 5d06917

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Amazon Bedrock Swift Library and web playground
2+
3+
This repository contains projects demonstrating how to use Amazon Bedrock with Swift.
4+
5+
## Projects
6+
7+
### 1. Swift Bedrock Library
8+
9+
A tiny layer on top of the [AWS SDK for Swift](https://github.com/awslabs/aws-sdk-swift) for interacting with Amazon Bedrock foundation models. This library provides a convenient way to access Amazon Bedrock's capabilities from Swift applications.
10+
11+
[Go to Swift Bedrock Library →](swift-bedrock-library/README.md)
12+
13+
### 2. Swift FM Playground
14+
15+
An interactive web application that demonstrates the capabilities of Amazon Bedrock foundation models using the Swift Bedrock Library. The playground includes:
16+
17+
- A Swift "backend for frontend" that interfaces with Amazon Bedrock
18+
- A React frontend for interacting with the models through a user-friendly interface
19+
20+
[Go to Swift FM Playground →](swift-fm-playground/web-playground/README.md)
21+
22+
## Getting Started
23+
24+
Each project has its own README with specific setup instructions:
25+
26+
- For the Swift Bedrock Library, see the [library README](swift-bedrock-library/README.md)
27+
- For the Swift FM Playground, see the [playground README](swift-fm-playground/web-playground/README.md)
28+
29+
## Prerequisites
30+
31+
- Swift 6.0 or later
32+
- AWS account with access to Amazon Bedrock
33+
- [AWS credentials configured locally](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html) or [SSO configured with AWS Identity Center](https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-accounts.html) configured
34+
35+
## License
36+
37+
These projects are licensed under the Apache License 2.0. See the LICENSE files in each project for details.

0 commit comments

Comments
 (0)