Skip to content

Commit 76c272e

Browse files
sebstoSebastien Stormacq
andauthored
Fix broken links (#600)
This PR fixes broken links in the README and add a link to the project incubation process of the SSWG and to the repo GitHub issues. --------- Co-authored-by: Sebastien Stormacq <[email protected]>
1 parent 97583a7 commit 76c272e

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

readme.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@ You can read [the Swift AWS Lambda Runtime documentation](https://swiftpackagein
66
This guide contains the following sections:
77

88
- [The Swift AWS Lambda Runtime](#the-swift-aws-lambda-runtime)
9-
- [Pre-requisites](#pre-requisites)
9+
- [Prerequisites](#prerequisites)
1010
- [Getting started](#getting-started)
1111
- [Developing your Swift Lambda functions](#developing-your-swift-lambda-functions)
1212
- [Testing Locally](#testing-locally)
1313
- [Deploying your Swift Lambda functions](#deploying-your-swift-lambda-functions)
1414
- [Swift AWS Lambda Runtime - Design Principles](#swift-aws-lambda-runtime---design-principles)
1515

16-
The Swift runtime client is an experimental package. It is subject to change and intended only for evaluation purposes.
16+
The Swift runtime client is [incubating as part of the Swift Server Workgroup incubation process](https://www.swift.org/sswg/incubated-packages.html). It is an experimental package, subject to change, and intended only for evaluation purposes.
17+
18+
Open [issues on GitHub for support requests](https://github.com/awslabs/swift-aws-lambda-runtime/issues).
1719

1820
## The Swift AWS Lambda Runtime
1921

@@ -27,7 +29,7 @@ Combine this with Swift's developer friendliness, expressiveness, and emphasis o
2729

2830
Swift AWS Lambda Runtime was designed to make building Lambda functions in Swift simple and safe. The library is an implementation of the [AWS Lambda Runtime API](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-custom.html) and uses an embedded asynchronous HTTP Client based on [SwiftNIO](http://github.com/apple/swift-nio) that is fine-tuned for performance in the AWS Runtime context. The library provides a multi-tier API that allows building a range of Lambda functions: From quick and simple closures to complex, performance-sensitive event handlers.
2931

30-
## Pre-requisites
32+
## Prerequisites
3133

3234
- Ensure you have the Swift 6.x toolchain installed. You can [install Swift toolchains](https://www.swift.org/install/macos/) from Swift.org
3335

@@ -378,7 +380,7 @@ let runtime = LambdaRuntime {
378380
try await runtime.run()
379381
```
380382

381-
You can learn how to deploy and invoke this function in [the API Gateway example README file](Examples/APIGateway/README.md).
383+
You can learn how to deploy and invoke this function in [the API Gateway example README file](Examples/APIGatewayV2/README.md).
382384

383385
### Integration with Swift Service LifeCycle
384386

@@ -530,9 +532,9 @@ Please refer to [the full deployment guide available in the documentation](https
530532

531533
## Swift AWS Lambda Runtime - Design Principles
532534

533-
The [design document](Sources/AWSLambdaRuntime/Documentation.docc/Proposals/0001-v2-api.md) details the v2 API proposal for the swift-aws-lambda-runtime library, which aims to enhance the developer experience for building serverless functions in Swift.
535+
The [design document](Sources/AWSLambdaRuntime/Docs.docc/Proposals/0001-v2-api.md) details the v2 API proposal for the swift-aws-lambda-runtime library, which aims to enhance the developer experience for building serverless functions in Swift.
534536

535-
The proposal has been reviewed and [incorporated feedback from the community](https://forums.swift.org/t/aws-lambda-v2-api-proposal/73819). The full v2 API design document is available [in this repository](Sources/AWSLambdaRuntime/Documentation.docc/Proposals/0001-v2-api.md).
537+
The proposal has been reviewed and [incorporated feedback from the community](https://forums.swift.org/t/aws-lambda-v2-api-proposal/73819). The full v2 API design document is available [in this repository](Sources/AWSLambdaRuntime/Docs.docc/Proposals/0001-v2-api.md).
536538

537539
### Key Design Principles
538540

0 commit comments

Comments
 (0)