README.md in s3_website-1.6.4 vs README.md in s3_website-1.6.5
- old
+ new
@@ -22,11 +22,12 @@
## Usage
Here's how you can get started:
-* In [AWS IAM](https://console.aws.amazon.com/iam), create API credentials that have sufficient permissions to S3
+* Create API credentials that have sufficient permissions to S3. More info
+ [here](https://github.com/laurilehmijoki/s3_website/blob/master/additional-docs/setting-up-aws-credentials.md).
* Go to your website directory
* Run `s3_website cfg create`. This generates a configuration file called `s3_website.yml`.
* Put your AWS credentials and the S3 bucket name into the file
* Run `s3_website cfg apply`. This will configure your bucket to function as an
S3 website. If the bucket does not exist, the command will create it for you.
@@ -261,11 +262,11 @@
No more index.htmls in your URLs!
*Note*: If the root resource on your folder displays an error instead of the
index file, your source bucket in Cloudfront likely is pointing to the S3 Origin,
-*example.com.s3.amazonaws.com*. Update the source to the S3 Website Endpoint,
+*example.com.s3.amazonaws.com*. Update the source to the S3 Website Endpoint,
*e.g. example.com.s3-website-us-east-1.amazonaws.com*, to fix this.
### The headless mode
s3_website has a headless mode, where human interactions are disabled.
@@ -369,20 +370,24 @@
`concurrency_level` setting.
## Example configurations
See
-<https://github.com/laurilehmijoki/s3_website/blob/master/example-configurations.md>.
+<https://github.com/laurilehmijoki/s3_website/blob/master/additional-docs/example-configurations.md>.
## Known issues
Please create an issue and send a pull request if you spot any.
## Development
### Versioning
s3_website uses [Semantic Versioning](http://semver.org).
+
+In the spirit of semantic versioning, here is the definition of public API for
+s3_website: Within a major version, s3_website will not break
+backwards-compatibility of anything that is mentioned in this README file.
### Tests
* Install bundler and run `bundle install`
* Run all tests by invoking `rake test`