Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Update README.md

  • Loading branch information...
commit 1053d8fecbe78efb12ebb8c1f20b9339f88ec47d 1 parent 63dde37
Eric Oestrich authored

Showing 1 changed file with 10 additions and 5 deletions. Show diff stats Hide diff stats

  1. +10 5 README.md
15 README.md
Source Rendered
@@ -8,11 +8,16 @@ Raddocs is a browser for JSON outputted by the [rspec_api_documentation](http://
8 8 ## Install
9 9
10 10 `Gemfile`
11   -
12   - gem 'raddocs'
  11 +```ruby
  12 +gem 'raddocs'
  13 +```
13 14
14 15 `config/routes.rb`
15 16
16   - ...
17   - match "/docs" => Raddocs::App, :anchor => false
18   - ...
  17 +```ruby
  18 + match "/docs" => Raddocs::App, :anchor => false
  19 +```
  20 +
  21 +## Configuration
  22 +* docs_dir - where the JSON output from rspec_api_documentation is located
  23 +* 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.
Something went wrong with that request. Please try again.