]> git.immae.eu Git - github/fretlink/text-pipes.git/blobdiff - README.md
bump for pipes-4.4
[github/fretlink/text-pipes.git] / README.md
index 3befd45a7a37d8db2e9610722283b1bbdd39b4fd..a950a67ab7f8084a973aa53a6a8c838a9133db8c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,18 +1,10 @@
-text-pipes
+pipes-text
 ==========
 
-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 package follows the rule:
 
+    pipes-text : pipes-bytestring :: text : bytestring
 
-     >>> runEffect $ stdinLn >-> P.takeWhile (/= "quit") >-> stdoutLn
-     hi<Return>
-     hi
-     quit<Return>
-     >>> runSafeT $ runEffect $ readFile "README.md" >-> map toUpper >-> hoist lift stdout
-     TEXT-PIPES
-     ==========
-     TEXT PIPES, SOMEHOW TO BE FUSED WITH `PIPES-TEXT`.
-     ...
\ No newline at end of file
+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