README, interface spec

Author: pearkes

CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jack Pearkes
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,73 @@
+# Tugboat
+
+A command line tool for interacting with your [DigitalOcean](https://www.digitalocean.com/) droplets.
+
+## Installation
+
+    gem install tugboat
+
+## Configuration
+
+    $ tugboat authorize
+    Note: You can get this stuff at digitalocean.com/api_access
+
+    Enter your client key: ...
+    Enter your API Key: ...
+
+    Checking...done.
+
+## Usage
+
+### Retrieve a list of your droplets
+
+    $ tugboat list
+    pearkes-admin-001 (region: 1, size: 64, image ID: 2676)
+    pearkes-www-001 (region: 1, size: 64, image ID: 2561)
+    pearkes-api-001 (region: 1, size: 64, image ID: 6321)
+
+### SSH into a droplet
+
+    $ tugboat ssh admin
+    Found droplet "pearkes-admin-001"
+    Executing SSH...
+
+### SSH into a droplet with multiple matches
+
+    $ tugboat ssh www
+    Found multiple droplets:
+    1) pearkes-www-001
+    2) pearkes-www-002
+    Enter droplet number: 2
+    Executing SSH...
+
+### Create a droplet
+
+    $ tugboat create -n pearkes-www-002 -s 64 -i 2676 -r 1
+    Creating "pearkes-www-002" (region: 1, size: 64, image ID: 2676)...done.
+
+
+### Destroy a droplet
+
+    $ tugboat destroy admin
+    Warning! Potentially destructive action. Please re-enter droplet name. "pearkes-admin-001": ...
+    Destroying "pearkes-admin-001"...done.
+
+### Restart a droplet
+
+    $ tugboat restart admin
+    Restarting "pearkes-admin-001"...done.
+
+### Shut down a droplet
+
+    $ tugboat halt admin
+    Shutting down "pearkes-admin-001"...done.
+
+### Snapshot a droplet
+
+    $ tugboat snapshot admin
+    Queuing snapshot for "pearkes-admin-001"...done.
+
+## Contributing
+
+See the [contributing guide](CONTRIBUTING.md).
+