]> git.immae.eu Git - github/fretlink/text-pipes.git/blobdiff - pipes-text.cabal
add travis
[github/fretlink/text-pipes.git] / pipes-text.cabal
index bcd49110247f4c8feb238087d534868d2288625d..ccde9a0f48ea5ebd33ffe3849eee9bbeffc9ed4a 100644 (file)
@@ -1,17 +1,19 @@
 name:                pipes-text
-version:             0.0.0.14
+version:             0.0.2.0
 synopsis:            Text pipes.
-description:         * This package will be in a draft, or testing, phase until version 0.0.1. Please report any installation difficulties, or any wisdom about the api, on the github page or the <https://groups.google.com/forum/#!forum/haskell-pipes pipes list>
-                     .
-                     This organization of the package follows the rule 
+description:         * This organization of the package follows the rule 
                      .
                      * @pipes-text : pipes-bytestring :: text : bytestring@ 
                      .
-                     Familiarity with the other three packages should give one an idea what to expect where. The package 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. 
+                     Familiarity with the other three packages should give one an idea what to expect where. The package has three principal modules, @Pipes.Text@ , @Pipes.Text.Encoding@ and @Pipes.Text.IO@; the division has more or less the significance it has in the @text@ library. A fourth module @Pipes.Prelude.Text@ is explained below.
+                     .
+                     Note that the module @Pipes.Text.IO@ is present as a convenience (as is @Data.Text.IO@).  Official pipes IO would use @Pipes.ByteString@ together with the bytestring decoding functions in @Pipes.Text.Encoding@.  In particular, the @Pipes.Text.IO@ functions use Text exceptions. 
                      .
-                     Note that the module @Pipes.Text.IO@ is present as a convenience (as is @Data.Text.IO@).  Official pipes IO would use @Pipes.ByteString@ together with the bytestring decoding functions present here, based on Michael Snoyman's excellent @streaming-commons@ package.  In particular, the @Pipes.Text.IO@ functions use Text exceptions. 
+                     The fourth module @Pipes.Prelude.Text@ exports line-based Text producers and consumers as a drop-in replacement for the String material in @Pipes.Prelude@ and @Pipes.Safe.Prelude@. They can be used as one uses @Pipes.Prelude@ without reference to the rest of this package. See the caveats in the documentation for that 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@
+                     @Pipes.Text.IO@ and @Pipes.Prelude.Text@ use version 0.11.3 or later of the @text@ library. To use a (very) old version of @text@, install with the flag @-fnoio@
+
+
 
 homepage:            https://github.com/michaelt/text-pipes
 bug-reports:         https://github.com/michaelt/text-pipes/issues
@@ -34,7 +36,7 @@ flag noio
 
 library
   exposed-modules:     Pipes.Text, Pipes.Text.Encoding
-  build-depends:       base              >= 4       && < 5   ,
+  build-depends:       base              >= 4       && < 5  ,
                        bytestring        >= 0.9.2.1 && < 0.11,
                        text              >= 0.11.2  && < 1.3 ,
                        streaming-commons >= 0.1     && < 0.2 ,  
@@ -50,6 +52,5 @@ library
   ghc-options: -O2
 
   if !flag(noio)
-    exposed-modules:   Pipes.Text.IO, Pipes.Text.Tutorial
+    exposed-modules:   Pipes.Text.IO, Pipes.Text.Tutorial,  Pipes.Prelude.Text
     build-depends:     text >=0.11.3              && < 1.3
-