ready for release

Author: softprops

CHANGELOG.md

@@ -1,7 +1,7 @@
-# 0.2.0-rust-1.31.0 (unreleased)
+# 0.2.0-rust-1.31.1
 
 * Breaking change: move to now officially supported `provided` runtime
-* Upgrade to rust 1.13.0 default image for rust ( 2018 edition )
+* Upgrade to Rust `1.13.0`, enabling the first stable version `2018 edition` Rust.
 
 # 0.1.*
 

README.md

@@ -2,30 +2,30 @@
 
 ## 🤔 about
 
-This image extends [lambda ci `provided`](https://github.com/lambci/docker-lambda#documentation) builder docker image, a faithful reproduction of the actual AWS provided lambda runtime environment,
+This image extends [lambda ci `provided`](https://github.com/lambci/docker-lambda#documentation) builder docker image, a faithful reproduction of the actual AWS "**provided**" Lambda runtime environment,
 and installs [rustup](https://rustup.rs/) and the *stable* rust toolchain.
 
 ## 📦 install
 
-Tags for this docker follow the convention `softprops/lambda-rust:{version}-rust-{rust-stable-version}'
-Where rust-version is a stable version of rust.
+Tags for this docker image follow the naming convention `softprops/lambda-rust:{version}-rust-{rust-stable-version}`
+where `{rust-stable-version}` is a stable version of rust.
 
 You can find a list of available docker tags [here](https://hub.docker.com/r/softprops/lambda-rust/)
 
+> 💡 If you don't find the version you're looking for, please open a new github issue to publish one
+
 You can also depend directly on `softprops/lambda-rust:latest` for the most recently published version.
 
 ## 🤸 usage
 
-The default docker entrypoint will build a release optimized version your rust artifact under `target/lambda/release` to
+The default docker entrypoint will build a packaged release optimized version your Rust artifact under `target/lambda/release` to
 isolate the lambda specific build artifacts from your host-local build artifacts.
 
 You will want to volume mount `/code` to the directory containing your cargo project.
 
-You can pass additional flags to cargo by setting the `CARGO_FLAGS` docker env variable
-
-A typical docker run might look like the following
+You can pass additional flags to `cargo`, the Rust build tool, by setting the `CARGO_FLAGS` docker env variable
 
-> 💡 the -v (volume mount) flags for `/root/.cargo/{registry,git}` are optional but when supplied, provides a much faster turn around when doing iterative development
+A typical docker run might look like the following.
 
 ```bash
 $ docker run --rm \
@@ -35,27 +35,29 @@ $ docker run --rm \
 	softprops/lambda-rust
 ```
 
+> 💡 The -v (volume mount) flags for `/root/.cargo/{registry,git}` are optional but when supplied, provides a much faster turn around when doing iterative development
+
 ## 🔬 local testing
 
-Once you've build a Rust lambda function artifact the `provided` runtime expects
-deployments of that artifact to be named "**bootstrap**". The lambda-rust docker image
-builds a zip file, named after the binary, containing your binary files renamed to bootstrap
+Once you've built a Rust lambda function artifact, the `provided` runtime expects
+deployments of that artifact to be named "**bootstrap**". The `lambda-rust` docker image
+builds a zip file, named after the binary, containing your binary files renamed to "bootstrap"
 
-You can invoke this bootstap executable with the lambda-ci provided docker image.
+You can invoke this bootstap executable with the lambda-ci docker image for the `provided` AWS lambda runtime.
 
 ```sh
 # start a docker container replicating the "provided" lambda runtime
 # awaiting an event to be provided via stdin
 $ unzip \
- target/lambda/release/{your-binary-name}.zip \
- -d /tmp/lambda && \
- docker run \
+    target/lambda/release/{your-binary-name}.zip \
+    -d /tmp/lambda && \
+  docker run \
     -i -e DOCKER_LAMBDA_USE_STDIN=1 \
     --rm \
     -v /tmp/lambda:/var/task \
     lambci/lambda:provided
 
-# provide payload via stdin (typically a json blob)
+# provide an event payload via stdin (typically a json blob)
 
 # Ctrl-D to yield control back to your function
 ```