README.md in yard-api-0.1.4 vs README.md in yard-api-0.1.5

- old
+ new

@@ -6,14 +6,30 @@ ## Usage TODO +## Configuration + +`yard-api` will look for a file in `config/yard_api.yml` in the Rails root for customizations. Configuration fields not specified in that file will be filled with the default values found in [config/yard_api.yml](https://github.com/amireh/yard-api/blob/master/config/yard_api.yml). + +Read that file to view all the available options. + ## Notes - can only document classes and class methods; modules, root objects, and constants are ignored ## Changelog + +**15/9/2014** + +- `@argument` tags can now be formatted in a table by setting the `tabular_arguments` option to true +- `@argument_scope`: a new tag that improves the formatting of endpoint arguments that are scoped by a common prefix (e.g, nested inside a json object), like `user[name]` => `name` +- `@argument` can now parse accepted values in two formats; inline within the types array, or by explicitly writing it in the tag text using any of `Accepted values: [...]`, `Accepts: [...]`, or `Possible values: [...]` +- A new option: `strict_arguments` that provides a default for the `is_required` property of `@argument` tags. This default is used if the tag does not explicitly state `Optional` or `Required` in its type specifier. +- Support for dynamic javascript and style code based on options. See `templates/layout/setup.rb#inline_{javascripts,stylesheets}` +- A new set of options for customizing layout: `content_width`, `sidebar_width` and `spacer` +- `github_url` and `github_branch` options for tuning api endpoint source links **14/9/2014** - Support for single-page output through the `one_file` option - Support for resource index generation ("All Resources") through the `resource_index` option \ No newline at end of file