packages/flamingo-s3/README.md from piobyte/flamingo

packages/flamingo-s3/README.md
Summary

Maintainability

Test Coverage

Issues
# flamingo-s3

<div style="text-align:center">
  <img style="width: 200px;image-rendering: -moz-crisp-edges;image-rendering: -o-crisp-edges;image-rendering: -webkit-optimize-contrast;-ms-interpolation-mode: nearest-neighbor;image-rendering: pixelated;" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QAAAAAAAD5Q7t/AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH4AYbEyIWn856RAAAARNJREFUOMvFkzFLA0EQhb8LVnaLWWwCIsRKLDTX2R1oeW0aiZ29YrNN2m39DWJjcc22B/cLDi00NgoSDKZYZBtNmsDZSMC7PRNI4SuHeR9vd2bgvxX4inEcFwA3G9ucfLzO68aYSv+azxyGIUIIrpzj6KDN6d0Lb5dnAEUZEvjM3cEQgPfJF53mJuPJJwCz/gVKqV9JKgnyPCcHeqMRezv7ADw833PdaoFSLHyC1hoApRRMLUwtPeC8WOfx+JA0Tf8GAEgp0VqTZRkAT84hhMA5V+ltLDOq7mDoNdcCrLVIKYmiCIDb3S2EEMsDyqqLXwEYYwL189PWWnwTKu9BY9VV9gKSJAGYT6Eu/sJbKMt3CyvrG47MZlX69GMPAAAAAElFTkSuQmCC" alt="">
</div>

![npm version](https://badge.fury.io/js/flamingo-s3.svg)
![MIT licensed](https://img.shields.io/github/license/piobyte/flamingo-s3.svg)

`flamingo-s3` is a [flamingo](https://github.com/piobyte/flamingo) addon to allow reading and converting images from aws [s3](https://aws.amazon.com/s3/) buckets.

# Installation

`npm i --save flamingo-s3`

# Documentation

see [flamingo-s3 docs](https://piobyte.github.io/flamingo-s3/index.html)

# Tutorials 

for basic installation and setup see [flamingo-s3/tutorial-usage](https://piobyte.github.io/flamingo-s3/tutorial-usage.html)