README.md in yard-api-0.2.2 vs README.md in yard-api-0.2.3
- old
+ new
@@ -1,14 +1,12 @@
# yard-api
[](https://travis-ci.org/amireh/yard-api)
-TODO
-
## Usage
-TODO
+See [https://amireh.github.io/yard-api].
### Compatibility options
#### `@argument` tags with names specified before types
@@ -32,10 +30,25 @@
## Notes
- can only document classes and class methods; modules, root objects, and constants are ignored
+## Generating the docs for YARD-API
+
+1. go to the `gh-pages` branch, check it out if you haven't
+2. run `bin/generate-docs`
+3. browse `index.html`
+
## Changelog
+
+**28/7/2015 [0.2.3]**
+
+- dropped the `@argument_scope` tag
+- JSON is available as an output format now
+- added usage documentation, found at [http://amireh.github.io/yard-api]
+- added an example app
+- various style improvements
+- `@example_request` is now able to output a sample cURL command.
**0.1.7**
- new compatibility option `leading_argument_name_fix`
\ No newline at end of file