Skip to content

Commit bcfe9f3

Browse files
committed
readme tweaks
1 parent d4d9835 commit bcfe9f3

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,15 @@
2323

2424
## 📦 Install
2525

26-
Install the plugin with npm
26+
Install the plugin inside your serverless project with npm.
2727

2828
```sh
2929
$ npm i -D serverless-rust
3030
```
31+
💡The `-D` flag adds it to your development dependencies in npm speak
3132

32-
💡 This serverless plugin assumes you are building Rustlang lambdas targeting the AWS Lambda "provided" runtime. The [AWS Lambda Rust Runtime](https://github.com/awslabs/aws-lambda-rust-runtime) makes this easy.
33+
34+
💡 This plugin assumes you are building Rustlang lambdas targeting the AWS Lambda "provided" runtime. The [AWS Lambda Rust Runtime](https://github.com/awslabs/aws-lambda-rust-runtime) makes this easy.
3335

3436
Add the following to your serverless project's `serverless.yml` file
3537

@@ -39,8 +41,8 @@ provider:
3941
name: aws
4042
runtime: rust
4143
plugins:
42-
# this adds informs serverless to use
43-
# the serverless-rust plugin
44+
# this registered the plugin
45+
# with serverless
4446
- serverless-rust
4547
# creates one artifact for each function
4648
package:
@@ -66,7 +68,7 @@ a custom section of your serverless.yaml configuration
6668

6769
```yaml
6870
custom:
69-
# this section allows for customization of the default
71+
# this section customizes of the default
7072
# serverless-rust plugin settings
7173
rust:
7274
# flags passed to cargo
@@ -80,11 +82,11 @@ custom:
8082
### 🥼 (experimental) local builds
8183

8284
While it's useful to have a build environment that matches your deployment
83-
environment, dockerized builds do come with some notable tradeoffs.
85+
environment, dockerized builds come with some notable tradeoffs.
8486

85-
The external dependency on docker itself often causes friction as an added dependency to your build.
87+
The external dependency on docker itself often causes friction as an added dependency to your build.
8688

87-
Depending on the docker image limits which versions of rust you can build with. The default docker image tracks **stable rust**. Some users might wish to try unstable versions of rust before the stabalize. Local builds enable that.
89+
Depending on a docker image limits which versions of rust you can build with. The default docker image tracks **stable rust**. Some users might wish to try unstable versions of rust before they stabilize. Local builds enable that.
8890

8991
If you wish to build lambda's locally, use the `dockerless` configuration setting.
9092

@@ -99,7 +101,7 @@ custom:
99101
+ dockerless: true
100102
```
101103

102-
This will build and link your lambda as a static binary that can be deployed in to the lambda execution environment using [MUSL](https://doc.rust-lang.org/edition-guide/rust-2018/platform-and-target-support/musl-support-for-fully-static-binaries.html).
104+
This will build and link your lambda as a static binary outside a container that can be deployed in to the lambda execution environment using [MUSL](https://doc.rust-lang.org/edition-guide/rust-2018/platform-and-target-support/musl-support-for-fully-static-binaries.html). The aim is that in future releases, this might become the default behavior.
103105

104106
In order to use this mode its expected that you install the `x86_64-unknown-linux-musl` target on all platforms locally with
105107

@@ -124,7 +126,7 @@ Using MUSL comes with some other notable tradeoffs. One of which is complication
124126
* With OpenSSL bindings which you can safely replace is with [rustls](https://github.com/ctz/rustls) or [vendor it](https://docs.rs/openssl/0.10.29/openssl/#vendored)
125127
* Other limitations are noted [here](https://github.com/KodrAus/rust-cross-compile#limitations).
126128

127-
If you find other MUSL specific issues, please reported them by [opening an issue](https://github.com/softprops/serverless-rust/issues/new?template=bug_report.md).
129+
If you find other MUSL specific issues, please report them by [opening an issue](https://github.com/softprops/serverless-rust/issues/new?template=bug_report.md).
128130

129131
### 🎨 Per function customization
130132

@@ -177,7 +179,6 @@ $ npx serverless invoke -f hello -d '{"hello":"world"}'
177179
$ npx serverless logs -f hello
178180
```
179181

180-
181182
## 🏗️ serverless templates
182183

183184
### ^0.2.*

0 commit comments

Comments
 (0)