dnrops
/
s3storage
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Wrote README

This commit is contained in:
Caleb Kleveter 2018-12-14 08:57:32 -06:00
parent 07bb3964d5
commit 482425c45e
No known key found for this signature in database
GPG Key ID: B38DBD5CF2C98D69
1 changed files with 29 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,3 +1,31 @@
# S3Storage
A description of this package.
An implementation of [skelpo/Storage](https://github.com/skelpo/Storage) for Amazon S3. Uses the [LiveUI/S3](https://github.com/LiveUI/S3) package for interacting with the S3 API.
## Installing
Add the package declaration to your manifest's `dependencies` array with the [latest version](https://github.com/skelpo/S3Storage/releases/latest):
```swift
.package(url: "https://github.com/skelpo/S3Storage.git", from: "0.1.0")
```
Then run `swift package update` and regenerate your Xcode project (if you have one).
## Configuration
Create and register an `S3Signer` instance with your app's services. Then register an `S3` instance (or another implementation of `S3StorageClient`) as `S3StorageClient`:
```swift
try services.register(S3(defaultBucket: bucket, signer: signer), as: S3StorageClient.self)
```
# API
You can find API documentation [here](http://www.skelpo.codes/S3Storage).
# License
S3Storage is under the [MIT license agreement](https://github.com/skelpo/S3Storage/blob/master/LICENSE).