README.md in knife-joyent-0.0.1 vs README.md in knife-joyent-0.0.2
- old
+ new
@@ -1,29 +1,52 @@
Knife Joyent
===
-This is a Knife plugin for Joyent CloudAPI. This plugin gives knife
-the ability to create, bootstrap, and manage servers on the Joyent Public Cloud
-as well as Cloud providers powered by Joyent's SmartDataCenter product.
+This is a [Knife](http://wiki.opscode.com/display/chef/Knife) plugin for Joyent CloudAPI. This plugin gives knife
+the ability to create, bootstrap, and manage servers on the [Joyent Public Cloud](http://www.joyentcloud.com/) as well as Cloud providers powered by Joyent's [SmartDataCenter](http://www.joyent.com/products/smartdatacenter/) product offering.
+For more information on Joyent CloudAPI, see: [CloudAPI Documentation](api.joyentcloud.com/docs)
+
## Installation
-With chef already installed (> 0.10.0):
+With chef already installed ``(> 0.10.0)``:
gem install knife-joyent
## Usage
-For available commands:
+For a list of commands:
knife joyent --help
+Currently available commands:
+
+ knife joyent flavor list <options>
+ knife joyent image list <options>
+ knife joyent key add -f <keyfile> -k <name>
+ knife joyent key delete <name>
+ knife joyent key list
+ knife joyent server create (options)
+ knife joyent server list <options>
+ knife joyent server reboot <server_id>
+ knife joyent server resize <server_id> -f <flavor>
+ knife joyent server start <server_id>
+ knife joyent server stop <server_id>
+ knife joyent snapshot create <server> <snapshot_name>
+ knife joyent snapshot delete <server> <snapshot_name>
+ knife joyent snapshot list <server_id>
+ knife joyent tag create <server_id> <tag> <value>
+ knife joyent tag delete <server_id> <tag>
+ knife joyent tag delete <server_id> -A
+ knife joyent tag list <server>
+
## Configuration
The following options can be specified in your knife configuration file
+``knife.rb``
-### Required
+#### Required
You can authenticate against CloudAPI using either:
a username and password
@@ -34,15 +57,17 @@
knife[:joyent_username] = "Your Joyent CloudAPI username"
knife[:joyent_keyname] = "Name of key stored on Joyent"
knife[:joyent_keyfile] = "/path/to/your/private/key"
-### Optional
+#### Optional
- # Specify a custom API endpoint, this is required if you want to specify
- # where you want to provision your machines, or if you are using knife with a
- # provider powered by SmartDataCenter.
- #
+**joyent_api_url**
+
+Specify a custom API endpoint, this is required if you want to specify
+where you want to provision your machines, or if you are using knife with a
+provider powered by [SmartDataCenter](http://www.joyent.com/products/smartdatacenter/).
+
# Defaults to https://us-west-1.api.joyentcloud.com/
knife[:joyent_api_url] = "https://us-sw-1.api.joyentcloud.com/"
## License