Skip to content
Browse files

Update readme to match recent design changes

  • Loading branch information...
1 parent 865dada commit 91f1fbd803f724812c509f17b7ad99806a7678cc @cdsmith committed Jun 9, 2012
Showing with 3 additions and 6 deletions.
  1. +3 −6 README.md
View
9 README.md
@@ -3,8 +3,9 @@ my-pipes
Alternative implementation of the pipes concept.
-The Pipe type is `Pipe a b u m r`, where:
+The Pipe type is `Pipe lo a b u m r`, where:
+ - `lo` is either `Leftovers` or `NoLeftovers`
- `a` is the input type
- `b` is the output type
- `u` is the upstream return type
@@ -18,9 +19,5 @@ The primitive stream operations are:
Exceptions and finalization are to be decided.
-There is a separate `PutbackPipe` type for the purpose of preserving leftover data. It does
-not form a category, and instead provides a specialized composition operator, `>++>`, which
-only permits composition on the left end of a pipeline.
-
Note that `simulatePipe` is the fundamental abstraction for running a `Pipe`. The more
-widely known `runPipe` is provided as a specialization.
+widely known `runPipe` is provided as a specialization.

0 comments on commit 91f1fbd

Please sign in to comment.
Something went wrong with that request. Please try again.