[WIP] Updated README and package config file.

jeremeamia · jeremeamia · commit 17dd56cf0125 · 2013-08-30T18:12:11.000-07:00
diff --git a/README.md b/README.md
@@ -18,24 +18,28 @@ The AWS Service Provider can be installed via [Composer](http://getcomposer.org)
 }
 ```
 
-## Usage
+## Configuration
+
+To use the AWS Service Provider, you must register the provider when bootstrapping your Laravel application.
 
-To use the AWS Service Provider, you must register the provider when bootstrapping your Laravel application. There are
-essentially two ways to do this.
+Publish the package configuration using Artisan.
 
-### 1. Use Laravel Configuration
+```sh
+php artisan config:publish aws/aws-sdk-php-laravel
+```
 
-Create a new `app/config/aws.php` configuration file with the following options:
+Update your settings in the generated `app/config/packages/aws/aws-sdk-php-laravel` configuration file.
 
 ```php
 return array(
-    'key'    => '<your-aws-access-key-id>',
-    'secret' => '<your-aws-secret-access-key>',
-    'region' => Aws\Common\Enum\Region::US_WEST_2,
+    'key'         => 'YOUR_AWS_ACCESS_KEY_ID',
+    'secret'      => 'YOUR_AWS_SECRET_KEY',
+    'region'      => 'us-east-1',
+    'config_file' => null,
 );
 ```
 
-Find the `providers` key in `app/config/app.php` and register the AWS Service Provider.
+Find the `providers` key in your `app/config/app.php` and register the AWS Service Provider.
 
 ```php
     'providers' => array(
@@ -44,7 +48,7 @@ Find the `providers` key in `app/config/app.php` and register the AWS Service Pr
     )
 ```
 
-Find the `aliases` key in `app/config/app.php` and add the AWS facade alias.
+Find the `aliases` key in your `app/config/app.php` and add the AWS facade alias.
 
 ```php
     'aliases' => array(
@@ -53,64 +57,29 @@ Find the `aliases` key in `app/config/app.php` and add the AWS facade alias.
     )
 ```
 
-### 2. Manual Instantiation
-
-You can also register the provider and configuration options at runtime. This could be done in your global bootstrapping
-process in `app/start/global.php`.
-
-```php
-use Aws\Common\Enum\Region;
-use Aws\Laravel\AwsServiceProvider;
-use Illuminate\Foundation\Application;
-
-// Instantiate a new application. This is normally done by the Laravel framework and the instance is available in
-// `app/start/global.php` for you to use.
-$app = new Application;
-
-// Register the AWS service provider and provide your configuration
-$app->register(new AwsServiceProvider($app), array(
-    'config' => array(
-        'aws' => array(
-            'key'    => '<your-aws-access-key-id>',
-            'secret' => '<your-aws-secret-access-key>',
-            'region' => Region::US_WEST_2,
-        ),
-    ),
-));
-```
-
-You can alternatively specify the path to an AWS config file (see [AWS SDK for PHP](http://github.com/aws/aws-sdk-php)
-for details about how to format this type of file).
-
-```php
-$app->register(new AwsServiceProvider($app), array('config' => array('aws' => '/path/to/aws/config/file.php')));
-```
-
-Either way, the value of `$app['config']['aws']` is passed directly into `Aws\Common\Aws::factory()`.
-
-### Retrieving and Using a Service Client
+## Usage
 
-In order to use the SDK from within your app, you need to retrieve it from the [Laravel IoC
+In order to use the AWS SDK for PHP within your app, you need to retrieve it from the [Laravel IoC
 Container](http://four.laravel.com/docs/ioc). The following example uses the Amazon S3 client to upload a file.
 
 ```php
 $s3 = App::make('aws')->get('s3');
 $s3->putObject(array(
-    'Bucket'     => '<your-bucket>',
-    'Key'        => '<the-name-of-your-object>',
-    'SourceFile' => '/path/to/the/file/you/are/uploading.ext',
+    'Bucket'     => 'YOUR_BUCKET',
+    'Key'        => 'YOUR_OBJECT_KEY',
+    'SourceFile' => '/the/path/to/the/file/you/are/uploading.ext',
 ));
 ```
 
-If the AWS Facade is registered within the `aliases` section of the application configuration, you can use
-the following more expressive method.
+If the AWS facade is registered within the `aliases` section of the application configuration, you can also use the
+following technique.
 
 ```php
 $s3 = AWS::get('s3');
 $s3->putObject(array(
-    'Bucket'     => '<your-bucket>',
-    'Key'        => '<the-name-of-your-object>',
-    'SourceFile' => '/path/to/the/file/you/are/uploading.ext',
+    'Bucket'     => 'YOUR_BUCKET',
+    'Key'        => 'YOUR_OBJECT_KEY',
+    'SourceFile' => '/the/path/to/the/file/you/are/uploading.ext',
 ));
 ```
 
diff --git a/src/config/config.php b/src/config/config.php
@@ -1,7 +1,53 @@
 <?php
 
 return array(
+
+    /*
+    |--------------------------------------------------------------------------
+    | Your AWS Credentials
+    |--------------------------------------------------------------------------
+    |
+    | In order to communicate with an AWS service, you must provide your AWS
+    | credentials including your AWS Access Key ID and your AWS Secret Key. You
+    | can obtain these keys by logging into your AWS account and visiting
+    | https://console.aws.amazon.com/iam/home?#security_credential.
+    |
+    | To use credentials from your environment or to use IAM Instance Profile
+    | credentials, please remove these config settings from your config. For
+    | more information see http://docs.aws.amazon.com/aws-sdk-php-2/guide/latest/configuration.html
+    |
+    */
     'key'    => 'YOUR_AWS_ACCESS_KEY_ID',
     'secret' => 'YOUR_AWS_SECRET_KEY',
-    //'region' => 'YOUR_REGION',
+
+    /*
+    |--------------------------------------------------------------------------
+    | AWS Region
+    |--------------------------------------------------------------------------
+    |
+    | Many AWS services are available in multiple regions. You should specify
+    | the AWS region you would like to use, but please remember that not every
+    | service is available in every region.
+    |
+    | These are the regions: us-east-1, us-west-1, us-west-2, us-gov-west-1
+    | eu-west-1, sa-east-1, ap-northeast-1, ap-southeast-1, ap-southeast-2
+    |
+    */
+    'region' => 'us-east-1',
+
+    /*
+    |--------------------------------------------------------------------------
+    | AWS Config File Location
+    |--------------------------------------------------------------------------
+    |
+    | Instead of specifying your credentials and region here, you can specify
+    | the location of an AWS SDK for PHP config file to use. These files provide
+    | more granular control over what credentials and regions you are using for
+    | each service. If you specify a filepath for this configuration setting,
+    | the others in this file will be ignored. See the SDK user guide for more
+    | information: http://docs.aws.amazon.com/aws-sdk-php-2/guide/latest/configuration.html#using-a-custom-configuration-file
+    |
+    */
+    'config_file' => null,
+
 );
