README.md in s3_website-0.2.1 vs README.md in s3_website-0.3.0

- old
+ new

@@ -10,27 +10,31 @@ * Help you use AWS Cloudfront to distribute your website * Improve page speed with HTTP cache control and gzipping * Set HTTP redirects for your website * (for other features, see the documentation below) +`s3_website` automatically supports [Jekyll](http://jekyllrb.com) and +[Nanoc](http://nanoc.ws) by recognising their output directories (*_site* for +Jekyll and *public/output* for Nanoc). If your website resides in some other +directory, you can point the directory to `s3_website` with a parameter. See +`s3_website help push` for more info. + ## Install -<span style="color: yellow">This project is still on beta level. Expect backward -incompatible changes.</span> +This project is still on beta level. Expect backward incompatible changes. gem install s3_website ## Usage Here's how you can get started: * Go to your website directory * Run `s3_website cfg create`. It generates a configuration file called `s3_website.yml` * Edit it with your details (you can use [ERB](http://ruby-doc.org/stdlib-1.9.3/libdoc/erb/rdoc/ERB.html) in the file) -* Run `s3_website cfg apply` This will configure - your bucket to function as an S3 website. If the bucket does not exist, - `s3_website cfg apply` will create it for you. +* 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. * Run `s3_website push` to push your website to S3. Congratulations! You are live. `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 @@ -163,11 +167,11 @@ If you already have a CloudFront distribution that serves data from your website S3 bucket, just add the following line into the file `s3_website.yml`: cloudfront_distribution_id: your-dist-id -Next time you run `s3_website`, it will invalidate the items on CloudFront and +Next time you run `s3_website push`, it will invalidate the items on CloudFront and thus force the CDN system to reload the changes from your website S3 bucket. #### Specifying custom settings for your CloudFront distribution `s3_website` lets you define custom settings for your CloudFront distribution. @@ -248,10 +252,10 @@ it programmatically by calling the same API as the executable `s3_website` does: ````ruby require 's3_website' is_headless = true -S3Website::Tasks.push('/path/to/your/website/_site/', is_headless) +S3Website::Tasks.push('/website/root', '/path/to/your/website/_site/', is_headless) ```` You can also use a basic `Hash` instead of a `s3_website.yml` file: ```ruby