Better documentation about krane HOT 5 CLOSED

I'm inclined to agree now that only thing we need to document with yard are the public interfaces.

from krane.

We use yard in Shopify core. Maybe it would make sense to use it here too.

from krane.

Ideas for more readme enhancements:

• Description of a few workflows like:
  • Getting started - using stuff from an 'examples' directory
  • Walk through the steps of a deploy
• GIF screen recording of terminal running a deploy locally - put this right near the top of the readme

from krane.

• Readme should reference a directory of examples, even if it is just our test fixtures

from krane.

After #581 and #582, do we need anything else?

I'm not sure about this:

Convert all existing comment-based docs to rdoc or yard

There aren't many comments, and most are specific to a particular condition inside a method, etc.

from krane.