plexus / yaks

Ruby library for building hypermedia APIs
http://rubygems.org/gems/yaks
MIT License
236 stars 26 forks source link

Errors in the README #71

Open moonglum opened 9 years ago

moonglum commented 9 years ago

Using Yaks for the first time in a project, and while going through the README, here are some problems I had in the README:

  1. The link in For all configuration options see [Yaks::Config::DSL](http://rdoc.info/gems/yaks/frames/Yaks/Config/DSL). is dead. And can't really find it, as this page does not have a child node for a DSL.
  2. Topic Associations: In the bulletpoint list you describe mapper, collection_mapper, rel, if and link_if as options. In the example you then use the href option (which was not described).
  3. The section about links is missing information about the option title. I found out about it here. I can help out with expanding that section if you want :smile: