Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
deleugpn committed Oct 16, 2020
1 parent 67df6ee commit 6bb3324
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Laravel S3 Minio 📁

This library provides a convenient way to write test code that runs
against Minio, an S3 compatible storage.

# Installation

```bash
composer require customergauge/minio
```

# Usage

```php
$minio = new Minio();

$minio->disk('my-bucket', function (S3Client $client, string $bucket) {
$this->post('/my/endpoint/that/interacts/with/s3', [])
->assertSuccessful();

$object = $client->getObject([
'Bucket' => $bucket,
'Key' => "/my/expected/s3/key"
]);

$content = $object['Body']->getContents();

$this->assertStringContainsString('partial-file-content', $content);
});
```

0 comments on commit 6bb3324

Please sign in to comment.