diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 17 |
1 files changed, 3 insertions, 14 deletions
@@ -1,17 +1,6 @@ | |||
1 | text-pipes | 1 | pipes-text |
2 | ========== | 2 | ========== |
3 | 3 | ||
4 | This repo is called `text-pipes`, but the package is named `pipes-text` as one might expect. | 4 | This package follows the rule `pipes-text : pipes-bytestring :: text : bytestring` It has three modules, `Pipes.Text` , `Pipes.Text.Encoding` and `Pipes.Text.IO`; the division has more or less the significance it has in the `text` library. |
5 | The two modules it contatins, `Pipes.Text` and `Pipes.Text.Parse`, use materials from [`pipes-text`](https://github.com/ibotty/pipes-text); | ||
6 | otherwise they follow the pattern of [`pipes-bytestring`](https://github.com/Gabriel439/Haskell-Pipes-ByteString-Library), adding a few `pipes-prelude`-like operations. | ||
7 | 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` | ||
8 | though `decodeUtf8` will then not exist. | ||
9 | 5 | ||
10 | >>> runEffect $ stdinLn >-> P.takeWhile (/= "quit") >-> stdoutLn | 6 | 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 |
11 | hi<Return> | ||
12 | hi | ||
13 | quit<Return> | ||
14 | >>> runSafeT $ runEffect $ readFile "README.md" >-> toUpper >-> hoist lift stdout | ||
15 | TEXT-PIPES | ||
16 | ========== | ||
17 | ... \ No newline at end of file | ||