Skip to content
This repository has been archived by the owner on Mar 8, 2023. It is now read-only.

Commit

Permalink
doc/README: add examples to toc
Browse files Browse the repository at this point in the history
[ci skip]
  • Loading branch information
skenqbx committed Apr 22, 2015
1 parent d8c2012 commit ca24c5b
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ Stability: 2 - Unstable

- [Installation](#installation)
- [Examples](#examples)
- [URL Only](#url-only)
- [URL & Plugin Options](#url--plugin-options)
- [Request & Plugin Options](#request--plugin-options)
- [Custom Client](#custom-client)
- [API](./doc/api.markdown)
- [Plugins](./doc/plugins.markdown)
- [Plugin API](./doc/plugin-api.markdown) - _the internals of RAIL_
Expand All @@ -40,7 +44,7 @@ $ npm install rail

## Examples

### globalClient - URL only
### URL only
Directly pass an URL that gets parsed into `proto`, `host`, `port` & `path`.

```js
Expand All @@ -53,7 +57,7 @@ RAIL.call('https://www.github.com/skenqbx/rail', function(response) {

[back to top](#table-of-contents)

### globalClient - URL & plugin options
### URL & Plugin Options
Again, only pass an URL, but this time as a property to allow passing of plugin options.

```js
Expand All @@ -71,7 +75,7 @@ RAIL.call({

[back to top](#table-of-contents)

### globalClient - request & plugin options
### Request & Plugin Options
The usual way of supplying every parameter separately.

```js
Expand All @@ -90,7 +94,7 @@ RAIL.call({

[back to top](#table-of-contents)

### Custom client
### Custom Client

```js
var RAIL = require('rail');
Expand Down

0 comments on commit ca24c5b

Please sign in to comment.