Skip to content

Fixing README so it points to the right Router class path #334

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
krasimir wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fixing README so it points to the right Router class path #334

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ Director handles routing for HTTP requests similar to `journey` or `express`:
//
// define a routing table.
//
var router = new director.http.Router({
var router = new director.Router({
'/hello': {
get: helloWorld
}
Expand Down Expand Up @@ -341,7 +341,7 @@ adhoc routing:
**HTTP Routing**

``` js
var router = new director.http.Router();
var router = new director.Router();

router.get(/\/some\/resource/, function () {
//
Expand All @@ -358,7 +358,7 @@ resources. Director exposes a simple way to do this for [Adhoc
Routing](#adhoc-routing) scenarios:

``` js
var router = new director.http.Router();
var router = new director.Router();

//
// Create routes inside the `/users` scope.
Expand Down Expand Up @@ -512,7 +512,7 @@ simple example where a `userId` is used repeatedly.
``` js
//
// Create a router. This could also be director.cli.Router() or
// director.http.Router().
// director.Router().
//
var router = new director.Router();

Expand Down Expand Up @@ -670,7 +670,7 @@ callback.
### Asynchronous route functions

``` js
var router = new director.http.Router().configure({ async: true });
var router = new director.Router().configure({ async: true });

router.on('/:foo/:bar/:bazz', function (foo, bar, bazz, next) {
//
Expand Down Expand Up @@ -735,7 +735,7 @@ route handlers, will contain the request in `this.req` and the response in
```js
var director = require('director');

var router = new director.http.Router().configure(options);
var router = new director.Router().configure(options);

//
// Attach properties to `this`
Expand Down Expand Up @@ -769,7 +769,7 @@ When you are performing HTTP routing there are two common scenarios:
* Stream the request body by manually calling `.pipe` or listening to the
`data` and `end` events.

By default `director.http.Router()` will attempt to parse either the `.chunks`
By default `director.Router()` will attempt to parse either the `.chunks`
or `.body` properties set on the request parameter passed to
`router.dispatch(request, response, callback)`. The router instance will also
wait for the `end` event before firing any routes.
Expand All @@ -779,7 +779,7 @@ wait for the `end` event before firing any routes.
``` js
var director = require('director');

var router = new director.http.Router();
var router = new director.Router();

router.get('/', function () {
//
Expand All @@ -802,7 +802,7 @@ you can use a simple request handler in your http server:
var http = require('http'),
director = require('director');

var router = new director.http.Router();
var router = new director.Router();

var server = http.createServer(function (req, res) {
req.chunks = [];
Expand Down Expand Up @@ -834,7 +834,7 @@ fired, you can pass the `{ stream: true }` options to the route.
``` js
var director = require('director');

var router = new director.http.Router();
var router = new director.Router();

router.get('/', { stream: true }, function () {
//
Expand Down