Added docs for SimpleS3 (async-aws#657)

* Added docs for SimpleS3

* minor

couscous.yml

@@ -107,6 +107,9 @@ menu:
             sessions:
                 text: PHP Sessions
                 url: /integration/sessions.html
+            simple-s3:
+                text: Simple S3
+                url: /integration/simple-s3.html
 
     authentication:
         # Authentication providers are in alphabetical order

docs/clients/s3.md

@@ -9,6 +9,8 @@ The client supports presign of requests to be able to pass the URL to a normal m
 person so they can download a file within the next X minutes. Read more about presign
 [here](/features/presign.md).
 
+> **Note**: There is a [SimpleS3Client](/integration/simple-s3.md) that might be easier to work with for common use cases.
+
 ## Usage
 
 ### Upload files

docs/integration/simple-s3.md

@@ -0,0 +1,37 @@
+---
+category: integration
+---
+
+# Simple S3 client
+
+An abstraction layer above the S3Client that provides simpler functions to common
+tasks. The client will automatically switch to multipart upload for large files.
+
+## Install
+
+```shell
+composer require async-aws/simple-s3
+```
+
+## Usage
+
+```php
+use AsyncAws\SimpleS3\SimpleS3Client;
+
+$s3 = new SimpleS3Client();
+$resource = \fopen('/path/to/cat/image.jpg', 'r');
+$s3->upload('my-image-bucket', 'photos/cat_2.jpg', $resource);
+$s3->upload('my-image-bucket', 'photos/cat_2.txt', 'I like this cat');
+
+// Check if a file exists
+$s3->has('my-image-bucket', 'photos/cat_2.jpg'); // true
+
+// Get file URL
+$url = $s3->getUrl('my-image-bucket', 'photos/cat_2.jpg');
+echo $url; // https://my-image-bucket.s3.eu-central-1.amazonaws.com/photos/cat_2.jpg
+
+// Download a file
+$resource = $s3->download('my-image-bucket', 'photos/cat_2.jpg')->getContentAsResource();
+$text = $s3->download('my-image-bucket', 'photos/cat_2.txt')->getContentAsString();
+echo $text; // I like this cat
+```

src/Integration/Aws/SimpleS3/README.md

@@ -13,7 +13,7 @@ composer require async-aws/simple-s3
 
 ## Documentation
 
-See https://async-aws.com for documentation.
+See https://async-aws.com/integration/simple-s3.html for documentation.
 
 ## Contribute