README.md in aptible-cli-0.4.0 vs README.md in aptible-cli-0.4.1
- old
+ new
@@ -6,22 +6,47 @@
Command-line interface for Aptible services.
## Installation
-Install the command line tool using Rubygems:
+Add the following line to your application's Gemfile.
- gem install aptible-cli
+ gem 'aptible-cli'
+And then run `bundle install`.
+
+*NOTE: To install the `aptible` tool as a system-level binary, consider using the [aptible-toolbelt gem](https://github.com/aptible/aptible-toolbelt), which is performance-optimized through dependency pinning.*
+
## Usage
-TODO: Add usage notes.
+From `aptible help`:
+```
+Commands:
+ aptible apps # List all applications
+ aptible apps:create HANDLE # Create a new application
+ aptible config # Print an app's current configuration
+ aptible config:add # Add an ENV variable to an app
+ aptible config:rm # Remove an ENV variable from an app
+ aptible config:set # Alias for config:add
+ aptible config:unset # Alias for config:rm
+ aptible db:clone SOURCE DEST # Clone a database to create a new one
+ aptible db:create HANDLE # Create a new database
+ aptible db:dump HANDLE # Dump a remote database to file
+ aptible db:tunnel HANDLE # Create a local tunnel to a database
+ aptible login # Log in to Aptible
+ aptible rebuild # Rebuild an app, and restart its services
+ aptible restart # Restart all services associated with an app
+ aptible ssh [COMMAND] # Run a command against an app
+ aptible version # Print Aptible CLI version
+```
+
## Contributing
1. Fork the project.
1. Commit your changes, with specs.
1. Ensure that your code passes specs (`rake spec`) and meets Aptible's Ruby style guide (`rake rubocop`).
+1. If you add a command, update this README with the output of `aptible help | grep -v help`.
1. Create a new pull request on GitHub.
## Copyright and License
MIT License, see [LICENSE](LICENSE.md) for details.