Skip to content

Commit 642b298

Browse files
committed
docs: getting started & intro
1 parent c9e6053 commit 642b298

File tree

4 files changed

+8
-3
lines changed

4 files changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
NGINX AWS Signature Library to authenticate AWS services such as S3 and Lambda via NGINX and NGINX Plus.
44

5-
![](./docs/img/nginx-aws-signature.png)
5+
![](./docs/img/nginx-aws-signature-intro.png)
66

77
**TABLE OF CONTENTS:**
88

@@ -15,7 +15,10 @@ NGINX AWS Signature Library to authenticate AWS services such as S3 and Lambda v
1515

1616
## Getting Started
1717

18-
![](./docs/img/nginx-aws-signature-flow.png)
18+
This project is to provide the common library for your apps or services. To get this project up and running, the following nginx project can be used prior to implementing your project.
19+
20+
- [Getting Started with `nginx-s3-gateway`](https://github.com/nginxinc/nginx-s3-gateway#getting-started)
21+
- [Getting Started with `nginx-lambda-gateway`](https://github.com/nginxinc/nginx-aws-signature/blob/main/README.md#Getting-Started)
1922

2023
## Directory Structure and File Descriptions
2124

@@ -45,11 +48,13 @@ nginx-aws-signature
4548
└── Makefile automate to build/start/stop testing environment
4649
```
4750

51+
![](./docs/img/nginx-aws-signature-flow.png)
52+
4853
## How to Use
4954

5055
### Sparse Checkouts of Submodules
5156

52-
Create or update git submodule when using this lib in your repository. Otherwise, copy [`core/*.js`](./core/) into the prefered directory on your NGINX instance.
57+
Create or update `git submodule` when using this lib in your repository. Otherwise, skip the following steps, and copy [`core/*.js`](./core/) into the prefered directory on your NGINX instance.
5358

5459
#### Step 1. Choose one of the following options
5560
- Option 1. Clone this repo with a depth of 1 for the first time

docs/img/nginx-aws-signature-flow.png

29.1 KB
Loading
431 KB
Loading

docs/img/nginx-aws-signature.png

-425 KB
Binary file not shown.

0 commit comments

Comments
 (0)