README.md in s3_website-1.0.0 vs README.md in s3_website-1.0.1
- old
+ new
@@ -5,43 +5,51 @@
## What `s3_website` can do for you
* Create and configure an S3 website for you
* Upload your static website to AWS S3
+ * Jekyll and Nanoc are automatically supported
* 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
-This project is still on beta level. Expect backward incompatible changes.
-
gem install s3_website
## 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
* 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 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.
* 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
-incomprehensible or inconsistent.
+### For Jekyll users
+Run the `s3_website cfg create` in the root directory of your Jekyll project.
+`s3_website` will automatically look for the site output in the *_site*
+directory.
+
+### For Nanoc users
+
+Run the `s3_website cfg create` in the root directory of your Nanoc project.
+`s3_website` will automatically look for the site output in the *public/output*
+directory.
+
+### For others
+
+It's a good idea to store the `s3_website.yml` file in your project's root.
+Let's say the contents you wish to upload to your S3 website bucket are in
+*my_website_output*. You can upload the contents of that directory with
+`s3_website push --site my_website_output`.
+
### Using environment variables
You can use ERB in your `s3_website.yml` file which incorporates environment variables:
```yaml
@@ -66,12 +74,18 @@
Nanoc
* 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.
+
## Additional features
### Cache Control
You can use the `max_age` configuration option to enable more effective browser
@@ -289,12 +303,10 @@
### Tests
* Install bundler and run `bundle install`
* Run all tests by invoking `rake test`
- * Run the integration tests by running `bundle exec cucumber`
- * Run the unit tests by running `bundle exec rspec spec/lib/*.rb`
### Contributing
We (users and developers of s3_website) welcome patches, pull requests and
ideas for improvement.
@@ -318,11 +330,11 @@
MIT. See the LICENSE file for more information.
## Contributors
-This gem is created by [Lauri Lehmijoki](https://github.com/laurilehmijoki).
-Without the valuable work of [Philippe Creux](https://github.com/pcreux) on
+This gem is created by Lauri Lehmijoki. Without the valuable work of [Philippe
+Creux](https://github.com/pcreux) on
[jekyll-s3](https://github.com/laurilehmijoki/jekyll-s3), this project would not
exist.
Contributors (in alphabetical order)
* Alan deLevie