root
/
gl-store-s3.js
mirror of https://github.com/cderche/greenlock-storage-s3
2
0
Fork 0
Code Issues 1 Releases Wiki Activity

Update Readme.md

This commit is contained in:
Cyrille 2019-05-08 15:25:23 +01:00
parent 20c3e070ef
commit 31ea0fd695
1 changed files with 2 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -7,15 +7,7 @@ S3 backed storage strategy for greenlock-express.js (and greenlock.js)
## Requirements
You will need:
1. S3 Bucket (<a href="https://aws.amazon.com/s3/" target="_blank">more info.</a>)
2. AWS API credentials with read and write access to the bucket (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html" target="_blank">more info.</a>)
You will need to pass the following information to greenlock-storage-s3
1. Your accessKeyId
2. Your secretAccessKey
3. Your regionName
4. Your bucketName
You will need a s3 bucket and the corresponding credentials.
## Integration
@ -23,7 +15,7 @@ You will need to pass the following information to greenlock-storage-s3
```javascript
let store = require('./index').create({
let store = require('greenlock-storage-s3').create({
accessKeyId: accessKeyId // Your accessKeyId
, secretAccessKey: secretAccessKey // Your secretAccessKey
, regionName: regionName // Your regionName