Skip to content

Commit d4d9835

Browse files
committed
refresh readme
1 parent f491824 commit d4d9835

File tree

1 file changed

+27
-7
lines changed

1 file changed

+27
-7
lines changed

README.md

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,25 @@
1-
# serverless rust [![Build Status](https://github.com/softprops/serverless-rust/workflows/Main/badge.svg)](https://github.com/softprops/serverless-rust/actions) [![npm](https://img.shields.io/npm/v/serverless-rust.svg)](https://www.npmjs.com/package/serverless-rust)
1+
<div align="center">
2+
⚡ 🦀
3+
</div>
24

5+
<h1 align="center">
6+
serverless-rust
7+
</h1>
38

4-
> A ⚡ [Serverless framework](https://www.serverless.com/framework/docs/) ⚡ plugin for [Rustlang](https://www.rust-lang.org/) applications 🦀
9+
<p align="center">
10+
A ⚡ <a href="https://www.serverless.com/framework/docs/">Serverless framework</a> ⚡ plugin for <a href="https://www.rust-lang.org/">Rustlang</a> applications
11+
</p>
12+
13+
<div align="center">
14+
<a href="https://github.com/softprops/serverless-rust/actions">
15+
<img alt="GitHub actions build badge" src="https://github.com/softprops/serverless-rust/workflows/Main/badge.svg"/>
16+
</a>
17+
<a href="https://www.npmjs.com/package/serverless-rust">
18+
<img alt="npm release badge" src="https://img.shields.io/npm/v/serverless-rust.svg"/>
19+
</a>
20+
</div>
21+
22+
<br />
523

624
## 📦 Install
725

@@ -39,7 +57,7 @@ functions:
3957
method: GET
4058
```
4159
42-
> 💡 The Rust Lambda runtime requires a binary named `bootstrap`. This plugin renames the binary cargo builds to `bootstrap` for you before packaging. You do **not** need to do this manually in your Cargo.toml configuration file.
60+
> 💡 The Rust Lambda runtime requires a binary named `bootstrap`. This plugin renames the binary cargo builds to `bootstrap` for you. You do **not** need to do this manually in your `Cargo.toml` configuration file.
4361

4462
## 🖍️ customize
4563

@@ -61,12 +79,14 @@ custom:
6179

6280
### 🥼 (experimental) local builds
6381

64-
While it's useful to have a build environment match your deployment
82+
While it's useful to have a build environment that matches your deployment
6583
environment, dockerized builds do come with some notable tradeoffs.
6684

67-
The external dependency on docker itself often causes friction as an added dependency to your build. Depending on the docker image limited which versions of rust you could deploy with. The docker image tracked stable rust. Some users might wish to try unstable versions early. Local builds enable that.
85+
The external dependency on docker itself often causes friction as an added dependency to your build.
86+
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.
6888

69-
If you wish to build lambda's locally, this plugin also supports an experimental `dockerless` mode.
89+
If you wish to build lambda's locally, use the `dockerless` configuration setting.
7090

7191
```diff
7292
custom:
@@ -79,7 +99,7 @@ custom:
7999
+ dockerless: true
80100
```
81101

82-
This will build and link your lambda as a static binary that can be deployed in to the lambda execution environment as a static binary using [MUSL](https://doc.rust-lang.org/edition-guide/rust-2018/platform-and-target-support/musl-support-for-fully-static-binaries.html).
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).
83103

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

0 commit comments

Comments
 (0)