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.
same comment here...  the link is not rendering in the output.