Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
oestrich committed Jun 2, 2012
1 parent 63dde37 commit 1053d8f
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Expand Up @@ -8,11 +8,16 @@ Raddocs is a browser for JSON outputted by the [rspec_api_documentation](http://
## Install

`Gemfile`

gem 'raddocs'
```ruby
gem 'raddocs'
```

`config/routes.rb`

...
match "/docs" => Raddocs::App, :anchor => false
...
```ruby
match "/docs" => Raddocs::App, :anchor => false
```

## Configuration
* docs_dir - where the JSON output from rspec_api_documentation is located
* docs_mime_type - if you use the middleware, what mime type are you serving your docs as, must be a regex. eg: `/text\/vnd.org.oestrich.raddocs\+plain/`

0 comments on commit 1053d8f

Please sign in to comment.