Permalink
Browse files

document fry.include

  • Loading branch information...
1 parent 0071523 commit d3af14c9472447463233c8e2aebcfcc340bb9896 @substack committed May 15, 2012
Showing with 9 additions and 2 deletions.
  1. +9 −2 README.markdown
View
@@ -53,12 +53,19 @@ var fritter = require('fritter')
var fry = fritter(src, context={})
--------------------------------
-Return a `fry` object given some javascript source `src` and some `context` to
-execute in and populate.
+Return a `fry` object given some optional javascript source `src` and some
+`context` to execute in and populate.
`fry` emits `'error'` events with the error object and the present callstack as
arguments when exceptions in `src` are thrown.
+fry.include(src, opts={})
+-------------------------
+
+Include and wrap some javascript source `src`. Use `opts.filename` to associate
+nodes in the stack with filenames so custom error handlers know what file an
+exception originated form.
+
attributes
==========

0 comments on commit d3af14c

Please sign in to comment.