Update README

Author: stevapple

Examples/CloudFunctions/README.md

@@ -1,8 +1,6 @@
 # Serverless Cloud Functions Examples
 
-This sample project is a collection of cloud functions that demonstrates
-how to write a simple SCF function in Swift, and how to package and deploy it
-to the Tencent SCF Platform.
+This sample project is a collection of cloud functions that demonstrates how to write a simple SCF function in Swift, and how to package and deploy it to the Tencent SCF Platform.
 
 The scripts are prepared to work from the `CloudFunctions` folder.
 
@@ -11,7 +9,7 @@ git clone https://github.com/stevapple/swift-tencent-scf-runtime.git
 cd swift-tencent-scf-runtime/Examples/CloudFunctions
 ```
 
-Note: The example scripts assume you have [jq](https://stedolan.github.io/jq/download/) command line tool installed.
+Note: The example scripts assume you have [jq](https://stedolan.github.io/jq/download/) command line tool installed. You're recommended to deploy with Serverless Framework in your own project.
 
 ## Deployment instructions using TCCLI and COSCMD
 
@@ -41,14 +39,14 @@ To use Serverless to deploy this sample to Tencent Cloud:
 
 1. Install Serverless by following the [instructions](https://www.serverless.com/framework/docs/getting-started/).
 If you already have installed, be sure you have the latest version.
-The examples have been tested with the version 1.78.1.
+The examples have been tested with the version 1.80.0.
 
 ```
 $ serverless --version
-Framework Core: 1.78.1
-Plugin: 3.7.0
+Framework Core: 1.80.0
+Plugin: 3.8.0
 SDK: 2.3.1
-Components: 2.34.1
+Components: 2.34.9
 ```
 
 2. Build, package and deploy the cloud function
@@ -63,7 +61,7 @@ The script will ask you which sample function you wish to deploy.
 
 For the APIGateway sample, the Serverless template provides an endpoint with API Gateway which you can use to test the cloud function. 
 
-Outuput example:
+Output example:
 
 ```
 $ sls deploy
@@ -85,10 +83,10 @@ triggers:
 
 Full details: https://serverless.cloud.tencent.com/apps/SwiftAPIGatewayDemo/SwiftAPIGatewayDemo/dev
 
-31s › SwiftAPIGatewayDemo › Success
+7s › SwiftAPIGatewayDemo › Success
 ```
 
-For example:
+Test command example:
 
 ```
 curl http://service-jyl9i6mc-1258834142.bj.apigw.tencentcs.com/release/api
@@ -104,4 +102,4 @@ For extensive usage, you need to customize `serverless.yml` yourself.
 ./scripts/serverless-remove.sh
 ```
 
-The script will ask you which sample function you wish to remove from the previous deployment.
+The script will ask you which sample function you wish to remove from the previous deployment.

README.md

@@ -8,21 +8,17 @@ When using serverless functions, attention must be given to resource utilization
 
 Combine this with Swift's developer friendliness, expressiveness, and emphasis on safety, and we have a solution that is great for developers at all skill levels, scalable, and cost effective.
 
-Swift Tencent SCF Runtime is a forked version form [Swift AWS Lambda Runtime](https://github.com/swift-server/swift-aws-lambda-runtime), designed to make building cloud functions in Swift simple and safe. The library is an implementation of the [Tencent SCF Custom Runtime API](https://cloud.tencent.com/document/product/583/47274#custom-runtime-.E8.BF.90.E8.A1.8C.E6.97.B6-api) and uses an embedded asynchronous HTTP Client based on [SwiftNIO](http://github.com/apple/swift-nio) that is fine-tuned for performance in the SCF Custom Runtime context. The library provides a multi-tier API that allows building a range of cloud functions: From quick and simple Closures to complex, performance-sensitive event handlers.
+Swift Tencent SCF Runtime is a forked version from [Swift AWS Lambda Runtime](https://github.com/swift-server/swift-aws-lambda-runtime), designed to make building cloud functions in Swift simple and safe. The library is an implementation of the [Tencent SCF Custom Runtime API](https://cloud.tencent.com/document/product/583/47274#custom-runtime-.E8.BF.90.E8.A1.8C.E6.97.B6-api) and uses an embedded asynchronous HTTP Client based on [SwiftNIO](http://github.com/apple/swift-nio) that is fine-tuned for performance in the SCF Custom Runtime context. The library provides a multi-tier API that allows building a range of cloud functions: From quick and simple Closures to complex, performance-sensitive event handlers.
 
 ## Project status
 
-This is the beginning of an open-source project actively seeking contributions.
-While the core API is considered stable, the API may still evolve as we get closer to a `1.0` version.
-There are several areas which need additional attention, including but not limited to:
+This is the beginning of an open-source project actively seeking contributions. While the core API is considered stable, the API may still evolve as we get closer to a `1.0` version. There are several areas which need additional attention, including but not limited to:
 
 * Further performance tuning
 * Additional trigger events
 * Additional documentation and best practices
 * Additional examples
 
-By August 2020, [SCF Custom Runtime](https://cloud.tencent.com/document/product/583/47274) is also at an early stage. You may encounter some problems triggered by the SCF Runtime Engine itself, or the API changes and deprecations. You are welcome to open issues actively on those problems.
-
 ## Getting started
 
 If you have used [Swift AWS Lambda Runtime](https://github.com/swift-server/swift-aws-lambda-runtime), you may find most of the APIs familiar. If you have never used Tencent SCF, AWS Lambda or Docker before, check out this [getting started guide](https://fabianfett.de/getting-started-with-swift-aws-lambda-runtime) which helps you with every step from zero to a running cloud function.
@@ -36,6 +32,9 @@ import PackageDescription
 
 let package = Package(
     name: "my-cloud-function",
+    platforms: [
+        .macOS(.v10_13),
+    ],
     products: [
         .executable(name: "MyCloudFunction", targets: ["MyCloudFunction"]),
     ],
@@ -358,7 +357,7 @@ SCF.run { (context, name: String, callback: @escaping (Result<String, Error>) ->
 }
 ```
 
-We simulate the SCF environment with some variables set by default. The value set by user code is of the highest priority, while the framework simulation has the lowest.
+We simulate the [SCF environment](https://cloud.tencent.com/document/product/583/30228) with some variables set by default. The value set by user code is of the highest priority, while the framework's default has the lowest.
 
 You can read some contextual variables through `SCF.Context`. All the environment variables can be accessed through `SCF.Env`.