on master help sign in
Add a note about non-boot dependencies
commit0a9d524c51e62fb2b2515ed727165e0d691d3a1a authorHarendra Kumar <harendra@composewell.com> dateMon 13 Mar 2023, 15:19 (4 years ago) parent9fc9651
1 file changed+13−8
core/streamly-core.cabal+13−8
core/streamly-core.cabal+13−8
@@ -3,16 +3,21 @@ name: streamly-core
33version: 0.1.0
44synopsis: Streaming, parsers, arrays and more
55description:
6− Streamly comprises two packages, the
7− <https://hackage.haskell.org/package/streamly-core streamly-core> package
8− provides functionality that depends only on boot libraries, and
9− the <https://hackage.haskell.org/package/streamly streamly> package
10− provides additional functionality like concurrency, time, lifted
11− exceptions, and networking. For unified documentation visit
12− <https://streamly.composewell.com the streamly website>.
6+ Streamly consists of two packages: "streamly-core" and "streamly".
7+ <https://hackage.haskell.org/package/streamly-core streamly-core>
8+ provides basic features, and depends only on GHC boot libraries (see
9+ note below), while
10+ <https://hackage.haskell.org/package/streamly streamly> provides
11+ higher-level features like concurrency, time, lifted exceptions,
12+ and networking. For documentation, visit the
13+ <https://streamly.composewell.com Streamly website>.
1314 .
1415 This package provides streams, arrays, parsers, unicode text, file
15− IO, console IO functionality of the streamly library.
16+ IO, and console IO functionality.
17+ .
18+ Note: The dependencies "heaps" and "monad-control" are included in
19+ the package solely for backward compatibility, and will be removed in
20+ future versions.
1621
1722homepage: https://streamly.composewell.com
1823bug-reports: https://github.com/composewell/streamly/issues