Updating readme for more possible use cases

[TheLonelyGhost]

No documentation indicated that output when using -h changed based on the placement. For instance:

$ dandelion -h deploy
Usage: dandelion [options] <command> [<args>]
    -v, --version                    Display the current version
    -h, --help                       Display this screen
        --repo=[REPO]                Use the given repository
        --config=[CONFIG]            Use the given configuration file

  Available commands:
      deploy
      status

and

$ dandelion deploy -h
Usage dandelion deploy [options] [<revision>]
    --dry-run                       Show what would have been deployed

This also indicates --dry-run as an option when using deploy, which was highly valuable as I was getting ready to submit a pull request with this feature when I noticed it already existed.

SSH public key auth went undocumented so a note was added to the SFTP adapter to indicate how it was possible. This also provides more context for why the password param is sometimes optional.

[scttnlsn]

What do you mean "honors ssh config files"? Are you referring to .ssh/config? Or just that you don't need a password if your SSH key in configured on the remote SFTP server?

[TheLonelyGhost]

I was trying to come up with a way of notifying the user that this follows any SSH aliases set in ~/.ssh/config and /etc/ssh/ssh_config. I also wanted to note that this is how public key authentication is possible. This wasn't clear to me as a user until I experimented a little and did some research on the NetSFTP (and by extension, NetSSH) gem.

I'm open to suggestions on the wording. My goal was to keep it concise and avoid breaking the flow of the adapter summaries.

[scttnlsn]

Okay cool- I had not actually realized that was the case. I knew that SSH keys worked but had never tried it w/ config options. Maybe "honors SSH keys and config files" is better? Whatever you think is more clear. Let me know and I'll merge this in.

[TheLonelyGhost]

Funny you should mention that. SSH keys only default to ~/.ssh/id_rsa because of the contents of the system default SSH config file, /etc/ssh/ssh_config.

Check out HowTo Geek's guide on ssh aliasing for more configuration.

I'll link-ify the phrase "ssh config" to the above guide to clarify. This revelation allows for huge customizations in the sftp connection.

[scttnlsn]

Made the changes here: https://github.com/scttnlsn/dandelion/commit/4a19c8f9751e7890774088a5919db43f448e45a5