Feature/fix doc links

@brutski Please review and merge.

This PR fixes links in the README that must use YARD {file: ... } format because relative links need to inject 'file' in the path per YARD generation of files in 'doc' folder.
Yeah. This only renders as a link in the YARD docs generated from it. So, people need to use the hosted documentation noted at the top.