X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=82f8259c26aaed8e29e42b87d0892acc91e037b8;hb=409759e855afc27cfab263c1ab1b1fd9ab66d38a;hp=3befd45a7a37d8db2e9610722283b1bbdd39b4fd;hpb=a3a2bf437ff25cc9651e6b1f40f2e1f4d72f9bcb;p=github%2Ffretlink%2Ftext-pipes.git diff --git a/README.md b/README.md index 3befd45..82f8259 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,17 @@ text-pipes ========== -Text pipes, somehow to be fused with [`pipes-text`](https://github.com/ibotty/pipes-text). -This follows the pattern of `pipes-bytestring` (largely by skillful use of the -expedient of regular expressions), and adds a few -`pipes-prelude`-like operations for testing. - +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. >>> runEffect $ stdinLn >-> P.takeWhile (/= "quit") >-> stdoutLn hi hi quit - >>> runSafeT $ runEffect $ readFile "README.md" >-> map toUpper >-> hoist lift stdout + >>> runSafeT $ runEffect $ readFile "README.md" >-> toUpper >-> hoist lift stdout TEXT-PIPES ========== - TEXT PIPES, SOMEHOW TO BE FUSED WITH `PIPES-TEXT`. ... \ No newline at end of file