Skip to content

Commit b066f17

Browse files
committed
Updated README and a few other things.
1 parent 404371b commit b066f17

File tree

2 files changed

+27
-11
lines changed

2 files changed

+27
-11
lines changed

README.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,16 @@
66
[![Total Downloads](https://img.shields.io/packagist/dt/aws/aws-sdk-php-laravel.svg)](https://packagist.org/packages/aws/aws-sdk-php-laravel)
77
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/aws/aws-sdk-php?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
88

9-
A simple [Laravel 5](http://laravel.com/) service provider for making it easier to include the official [AWS SDK for PHP](https://github.com/aws/aws-sdk-php) into your Laravel application.
9+
This is a simple [Laravel](http://laravel.com/) service provider for making it easy to include the official
10+
[AWS SDK for PHP](https://github.com/aws/aws-sdk-php) in your Laravel and Lumen applications.
1011

11-
_(Looking for the Laravel 4 service provider? It's still available in the [1.0 branch](https://github.com/aws/aws-sdk-php-laravel/tree/1.0).)_
12+
The master branch of this repository and this README are for version 3.x of the service provider, which is implemented
13+
to work with Version 3 of the AWS SDK for PHP and Laravel 5.1+.
14+
15+
Past Versions:
16+
17+
* [2.0 branch](https://github.com/aws/aws-sdk-php-laravel/tree/2.0) - For Laravel 5.0 and Version 2 of the AWS SDK for PHP
18+
* [1.0 branch](https://github.com/aws/aws-sdk-php-laravel/tree/1.0) - For Laravel 4.x and Version 2 of the AWS SDK for PHP
1219

1320
## Installation
1421

@@ -18,7 +25,7 @@ The AWS Service Provider can be installed via [Composer](http://getcomposer.org)
1825
```json
1926
{
2027
"require": {
21-
"aws/aws-sdk-php-laravel": "~2.0"
28+
"aws/aws-sdk-php-laravel": "~3.0"
2229
}
2330
}
2431
```
@@ -54,8 +61,7 @@ By default, the package uses the following environment variables to auto-configu
5461
```
5562
AWS_ACCESS_KEY_ID
5663
AWS_SECRET_ACCESS_KEY
57-
AWS_REGION // default = us-east-1
58-
AWS_CONFIG_FILE // default = null
64+
AWS_REGION (default = us-east-1)
5965
```
6066

6167
To customize the configuration file, publish the package configuration using Artisan.
@@ -68,13 +74,23 @@ Update your settings in the generated `app/config/aws.php` configuration file.
6874

6975
```php
7076
return [
71-
'key' => 'YOUR_AWS_ACCESS_KEY_ID',
72-
'secret' => 'YOUR_AWS_SECRET_KEY',
73-
'region' => 'us-east-1',
74-
'config_file' => null,
77+
'credentials' => [
78+
'key' => 'YOUR_AWS_ACCESS_KEY_ID',
79+
'secret' => 'YOUR_AWS_SECRET_ACCESS_KEY',
80+
],
81+
'region' => 'us-west-2',
82+
'version' => 'latest',
83+
84+
// You can override settings for specific services
85+
'Ses' => [
86+
'region' => 'us-east-1',
87+
],
7588
];
7689
```
7790

91+
Learn more about [configuring the SDK](http://docs.aws.amazon.com/aws-sdk-php/v3/guide/guide/configuration.html) on
92+
the SDK's User Guide.
93+
7894
## Usage
7995

8096
In order to use the AWS SDK for PHP within your app, you need to retrieve it from the [Laravel IoC

composer.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@
1414
"require": {
1515
"php": ">=5.5.9",
1616
"aws/aws-sdk-php": "~3.0",
17-
"illuminate/support": "5.1.*"
17+
"illuminate/support": "~5.1"
1818
},
1919
"require-dev": {
20-
"laravel/framework": "5.1.*",
20+
"laravel/framework": "~5.1",
2121
"phpunit/phpunit": "~4.0"
2222
},
2323
"autoload": {

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy