X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=a950a67ab7f8084a973aa53a6a8c838a9133db8c;hb=17a14f6de0cf6ade58cafd81d5f50d9fce11f0bd;hp=a3e00faa161db5c8b686147cc6f02ababce260d5;hpb=434362b1d2ef75552f1328e47ad293e1f4c59cf1;p=github%2Ffretlink%2Ftext-pipes.git diff --git a/README.md b/README.md index a3e00fa..a950a67 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,10 @@ -text-pipes +pipes-text ========== -This repo is called `text-pipes`, but the package is named `pipes-text` as one might expect. -The two modules it contatins, `Pipes.Text` and `Pipes.Text.Parse`, use materials from [`pipes-text`](https://github.com/ibotty/pipes-text); -otherwise they follow the pattern of [`pipes-bytestring`](https://github.com/Gabriel439/Haskell-Pipes-ByteString-Library), adding a few `pipes-prelude`-like operations. -The most important function, `decodeUtf8`, written by ibotty, uses the development version of the text package; this package can however be built with the hackage `text` -though `decodeUtf8` will then not exist. +This package follows the rule: - >>> runEffect $ stdinLn >-> P.takeWhile (/= "quit") >-> stdoutLn - hi - hi - quit - >>> runSafeT $ runEffect $ readFile "README.md" >-> map toUpper >-> hoist lift stdout - TEXT-PIPES - ========== - ... \ No newline at end of file + pipes-text : pipes-bytestring :: text : bytestring + +The division of three modules, `Pipes.Text` , `Pipes.Text.Encoding` and `Pipes.Text.IO` has more or less the significance it has in the `text` library. + +Note that the module `Pipes.Text.IO` uses version 0.11.3 or later of the `text` library. (It thus works with the version of `text` that came with the 2013 Haskell Platform. To use an older `text`, install with the flag `-fnoio` \ No newline at end of file