bump for pipes-4.4

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

diff --git a/README.md b/README.md
index 1d49fed2d81c19aa11c3a0c99fda283cfcaf01fd..a950a67ab7f8084a973aa53a6a8c838a9133db8c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,10 @@
-text-pipes
+pipes-text
 ==========
 
-Text pipes
+This package follows the rule:
+
+    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