Skip to content

Commit c123812

Browse files
softpropsdavidbarsky
authored andcommitted
add docs.rs badges (aws#78)
1 parent 9c68a4f commit c123812

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
This package makes it easy to run AWS Lambda Functions written in Rust. This workspace includes multiple crates:
66

7-
* **`lambda-runtime-client`** is a client SDK for the Lambda Runtime APIs. You probably don't need to use this crate directly!
8-
* **`lambda-runtime`** is a library that makes it easy to write Lambda functions in Rust.
9-
* **`lambda-http`** is a library that makes it easy to write API Gateway proxy event focused Lambda functions in Rust.
7+
- [![Docs](https://docs.rs/lambda_runtime_client/badge.svg)](https://docs.rs/lambda_runtime_client) **`lambda-runtime-client`** is a client SDK for the Lambda Runtime APIs. You probably don't need to use this crate directly!
8+
- [![Docs](https://docs.rs/lambda_runtime/badge.svg)](https://docs.rs/lambda_runtime) **`lambda-runtime`** is a library that makes it easy to write Lambda functions in Rust.
9+
- [![Docs](https://docs.rs/lambda_http/badge.svg)](https://docs.rs/lambda_http) **`lambda-http`** is a library that makes it easy to write API Gateway proxy event focused Lambda functions in Rust.
1010

1111
## Example function
1212

@@ -100,9 +100,9 @@ Alternatively, you can build a Rust-based Lambda function declaratively using th
100100

101101
A number of getting started Serverless application templates exist to get you up and running quickly
102102

103-
* a minimal [echo function](https://github.com/softprops/serverless-aws-rust) to demonstrate what the smallest Rust function setup looks like
104-
* a minimal [http function](https://github.com/softprops/serverless-aws-rust-http) to demonstrate how to interface with API Gateway using Rust's native [http](https://crates.io/crates/http) crate (note this will be a git dependency until 0.2 is published)
105-
* a combination [multi function service](https://github.com/softprops/serverless-aws-rust-multi) to demonstrate how to set up a services with multiple independent functions
103+
- a minimal [echo function](https://github.com/softprops/serverless-aws-rust) to demonstrate what the smallest Rust function setup looks like
104+
- a minimal [http function](https://github.com/softprops/serverless-aws-rust-http) to demonstrate how to interface with API Gateway using Rust's native [http](https://crates.io/crates/http) crate (note this will be a git dependency until 0.2 is published)
105+
- a combination [multi function service](https://github.com/softprops/serverless-aws-rust-multi) to demonstrate how to set up a services with multiple independent functions
106106

107107
Assuming your host machine has a relatively recent version of node, you [won't need to install any host-wide serverless dependencies](https://blog.npmjs.org/post/162869356040/introducing-npx-an-npm-package-runner). To get started, run the following commands to create a new lambda Rust application
108108
and install project level dependencies.
@@ -162,7 +162,6 @@ $ unzip -o \
162162
# Ctrl-D to yield control back to your function
163163
```
164164

165-
166165
## lambda-runtime-client
167166

168167
Defines the `RuntimeClient` trait and provides its `HttpRuntimeClient` implementation. The client fetches events and returns output as `Vec<u8>`.
@@ -171,7 +170,7 @@ For error reporting to the runtime APIs the library defines the `RuntimeApiError
171170

172171
## lambda-runtime
173172

174-
This library makes it easy to create Rust executables for AWS lambda. The library defines a `lambda!()` macro. Call the `lambda!()` macro from your main method with an implementation the `Handler` type:
173+
This library makes it easy to create Rust executables for AWS lambda. The library defines a `lambda!()` macro. Call the `lambda!()` macro from your main method with an implementation the `Handler` type:
175174

176175
```rust
177176
pub trait Handler<E, O> {

0 commit comments

Comments
 (0)