Documentation seems fairly out of date

[dacarley]

Here are the issues I've noticed:

Missing documentation:
The '&' syntax for paths
.globalSetup()
Would be good to list out what can be configured here.
.timeout()
.reset()
.not()
.addHeader()
.addHeaders()
.removeHeader()
.responseType()
Actually, this appears to be pointless. The value of
.auth()
all of the request methods, such as .get() and .post()
.expectHeaderToMatch()
.expectJSONSchema()
format of the 'length' parameter to .expectJSONLength()
.inspectRequest()
.inspectResponse()
.inspectHeaders()
.inspectStatus()
.retry()
.waits()
.after()
.afterJSON()
.exceptionHandler()
.setResponseJSON()
.setResponseBody()
.setResponseHeaders()
.setResponseHeader()
the 'retry' param to toss()

All of the frisby matchers
toMatchOrBeNull
toMatchOrBeEmpty
toBeType
toBeTypeOrNull
toContainJson
toContainJsonTypes

Also, the documentation in README.MD should match up with the documentation on the frisbyjs.com website.

Additionally, it'd be great if a variety of example scripts were provided to demonstrate the power of Frisby.

I can take a crack at documenting some of this. A pull request makes sense for the README.MD and any examples, but what about for the website content?

[vlucas]

I would absolutely accept a PR to update the documentation and README. As for the website, I plan on moving it to a static website with markdown files, probably using something like middleman.

[kreutter]

I'd also like to offer some help on updating the website if possible. There is at least one example up there that doesn't work (fails) and the twitter examples are no longer working since they are using the no longer available older api.

[marcin-wosinek]

@vlucas how about moving documentation to github pages?

[vlucas]

I did - I just apparently never updated this ticket: https://github.com/vlucas/frisby-site

I ended up going with hexo, which is a node.js static site generator.

[cpanato]

@vlucas will try to update some docs in the frisby-site and make a PR