Skip to content

Commit

Permalink
improve the documentation
Browse files Browse the repository at this point in the history
I found it difficult to find information on how to add options, maybe this can help
  • Loading branch information
Guillaume Vincent committed Dec 23, 2014
1 parent 576fb93 commit 4c7e0ab
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,13 @@ Below are the options available to be passed into the **tv** plugin:
- `endpoint` - the debug console request path added to the server routes. Defaults to _'/debug/console'_.
- `queryKey` - the name or the request query parameter used to mark requests being debugged. Defaults to _debug_.
- `template` - the name of the template to use for the debug console. Defaults to _index_.

Below is an example of registering the tv plugin with some options:

```javascript
var options = {endpoint: '/awesome'};

server.register({register: Tv, options: options}, function (err) {
...
});
```

0 comments on commit 4c7e0ab

Please sign in to comment.