Bit of an overhaul of the readme with added yard

added a basic example that outlines how to use it

docs wip

a section on how dependencies are defined and resolved

yard is a development dependency

readme tweaks

make apidocs a bit more friendly for yard

more readme changes