README.md in s3_website-2.0.1 vs README.md in s3_website-2.1.0

- old
+ new

@@ -23,11 +23,11 @@ ## Usage Here's how you can get started: * 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). + [here](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. @@ -83,11 +83,10 @@ * Be simple to use: require only the S3 credentials and the name of the S3 bucket * Let the power users benefit from advanced S3 website features such as redirects, Cache-Control headers and gzip support * Be as fast as possible. Do in parallel all that can be done in parallel. -* Maintain 90% backward compatibility with the jekyll-s3 gem `s3_website` attempts to be a command-line interface tool that is easy to understand and use. For example, `s3_website --help` should print you all the things it can perform. Please create an issue if you think the tool is incomprehensible or inconsistent. @@ -341,13 +340,16 @@ ## Migrating from v1 to v2 Please read the [release note](/changelog.md#200) on version 2. It contains information on backward incompatible changes. +You can find the v1 branch +[here](https://github.com/laurilehmijoki/s3_website/tree/1.x). It's in +maintenance mode. This means that v1 will see only critical bugfix releases. + ## Example configurations -See -<https://github.com/laurilehmijoki/s3_website/blob/master/additional-docs/example-configurations.md>. +See [example-configurations](additional-docs/example-configurations.md). ## On security If the source code of your website is publicly available, ensure that the `s3_website.yml` file is in the list of ignored files.