Merge pull request #41 from evertrue/evertrue/eherot/clarify_s3_url_i…

…n_readme Add a note about the bucket name in the S3 URL (Fixes #40)
adamsb6 · Jan 21, 2015 · 0b81d08 · 0b81d08
2 parents c220c52 + 9a26f69
commit 0b81d08
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/README.rdoc b/README.rdoc
@@ -23,7 +23,7 @@ Attribute Parameters:
 * `aws_secret_access_key` - your AWS secret access key. (optional)
 * `token` - token used for temporary IAM credentials. (optional)
 * `bucket` - the bucket to pull from.
-* `s3_url` - Custom S3 URL. (optional)
+* `s3_url` - Custom S3 URL. If specified this URL *must* include the bucket name at the end. (optional)
 * `remote_path` - the S3 key to pull.
 * `owner` - the owner of the file. (optional)
 * `group` - the group owner of the file. (optional)