bump for pipes-4.4

[github/fretlink/text-pipes.git] / README.md

diff --git a/README.md b/README.md
index b5f343a6a60f75660f9c68e54cd8395cf418ff0a..a950a67ab7f8084a973aa53a6a8c838a9133db8c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,16 +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) and 
-otherwise follows 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 without it.
+This package follows the rule:
 
-     >>> runEffect $ stdinLn >-> P.takeWhile (/= "quit") >-> stdoutLn
-     hi<Return>
-     hi
-     quit<Return>
-     >>> runSafeT $ runEffect $ readFile "README.md" >-> map toUpper >-> hoist lift stdout
-     PIPES-TEXT
-     ==========
-     ...
\ 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