diff --git a/README.md b/README.md index 9af685c..daec74a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # @ppstreams/propagate-abort -A simple abort handler for ppstreams that just passes on an incoming abort notification to the source stream. +A simple abort handler for ppstreams that just passes on an incoming abort notification to the direct upstream. ## Example: @@ -8,6 +8,7 @@ A simple abort handler for ppstreams that just passes on an incoming abort notif "use strict"; const propagateAbort = require("@ppstreams/propagate-abort"); +const propagatePeek = require("@ppstreams/propagate-peek"); module.exports = function makeStream() { return { @@ -16,7 +17,8 @@ module.exports = function makeStream() { /* This example stream just passes through the upstream value */ return source.read(); }, - abort: propagateAbort + abort: propagateAbort, + peek: propagatePeek } }; ``` \ No newline at end of file