README.md in convox_installer-1.0.9 vs README.md in convox_installer-2.0.0

- old
+ new

@@ -1,13 +1,16 @@ # Convox Installer A Ruby gem that makes it easier to build a Convox installation script. This is like Chef/Ansible/Terraform for your initial Convox setup. -## NOTE: This software is an alpha version +# Requirements: Convox v2 -Please note that the code quality is not very good, and the test coverage needs to be improved. However, I've successfully set up a number of test and production deployments using this gem, and everything seems to work very well. The library also facilitates idempotency and crash-resistance, so you can easily re-run your installation script if something goes wrong. +This version of `convox_installer` is only designed to work with Convox v2. Please install the v2 CLI by following the instructions at their old documentation site: https://docsv2.convox.com/introduction/installation +## USE AT YOUR OWN RISK! THIS CODE IS PROVIDED WITHOUT ANY WARRANTIES OR GUARANTEES +We have successfully set up a number of test and production deployments using this gem. Everything seems to work very well. The library also facilitates idempotency and crash-resistance, so you can easily re-run your installation script if something goes wrong. However, if anything goes wrong, then you can end up with a large AWS bill if you're not careful. If anything crashes then make sure you double-check everything in your AWS account and shut down any leftover resources. **USE THIS SOFTWARE AT YOUR OWN RISK.** + ## Features - Idempotent. If this script crashes, you can restart it and it will pick up where it left off. Every step looks up the existing state, and only makes a change if things are not yet set up (or out of sync). @@ -147,10 +150,10 @@ - **Required Config:** `aws_region`, `aws_access_key_id`, `aws_secret_access_key`, `stack_name`, `instance_type` Runs `convox rack install ...`. Has some validations to ensure that all required settings are present. -#### `validate_convox_auth_and_set_host!` +#### `validate_convox_auth_and_write_host!` After running `install_convox`, call this method to ensure that the the `~/.convox/auth` file has been updated with the correct details (checks the rack name and AWS region.) Then it sets the rack host in `~/.convox/host` (if not already set.) #### `validate_convox_rack!`