@@ -46,7 +46,8 @@ that they use `nil` and `cons` instead of `[]` and `:`. Unlike lists, streams
46can be constructed from monadic effects, not just pure elements. Streams are
46can be constructed from monadic effects, not just pure elements. Streams are
47processed just like lists, with list like combinators, except that they are
47processed just like lists, with list like combinators, except that they are
48monadic and work in a streaming fashion. In other words streamly just completes
48monadic and work in a streaming fashion. In other words streamly just completes
49−what lists lack, you do not need to learn anything new.
49+what lists lack, you do not need to learn anything new. Please see [streamly vs
50+lists](docs/streamly-vs-lists.md) for a detailed comparison.
51Not surprisingly, the monad instance of streamly is a list transformer, with
52Not surprisingly, the monad instance of streamly is a list transformer, with
52concurrency capability.
53concurrency capability.
@@ -94,11 +95,9 @@ performance results and a comparison with the `async` package.
95## Installing and using
96## Installing and using
98−[INSTALL.md](https://github.com/composewell/streamly/tree/master/INSTALL.md)
99−for instructions on how to use streamly with your Haskell build tool or package
98+Please see [INSTALL.md](INSTALL.md) for instructions on how to use streamly
99+with your Haskell build tool or package manager. You may want to go through it
100−manager. You may want to go through it before jumping to run the examples
100+before jumping to run the examples below.
103The module `Streamly` provides just the core stream types, type casting and
102The module `Streamly` provides just the core stream types, type casting and
104concurrency control combinators. Stream construction, transformation, folding,
103concurrency control combinators. Stream construction, transformation, folding,
@@ -574,8 +573,8 @@ For more information, see:
575 * [Detailed tutorial](https://hackage.haskell.org/package/streamly/docs/Streamly-Tutorial.html)
574 * [Detailed tutorial](https://hackage.haskell.org/package/streamly/docs/Streamly-Tutorial.html)
576 * [Reference documentation](https://hackage.haskell.org/package/streamly)
575 * [Reference documentation](https://hackage.haskell.org/package/streamly)
577− * [Examples](https://github.com/composewell/streamly/tree/master/examples)
576+ * [Examples](examples)
578− * [Guides](https://github.com/composewell/streamly/blob/master/docs)
577+ * [Guides](docs)
579 * [Streaming benchmarks](https://github.com/composewell/streaming-benchmarks)
578 * [Streaming benchmarks](https://github.com/composewell/streaming-benchmarks)
580 * [Concurrency benchmarks](https://github.com/composewell/concurrency-benchmarks)
579 * [Concurrency benchmarks](https://github.com/composewell/concurrency-benchmarks)
@@ -601,9 +600,7 @@ See the `credits` directory for full list of contributors, credits and licenses.
601## Contributing
600## Contributing
603The code is available under BSD-3 license
602The code is available under BSD-3 license
604−[on github](https://github.com/composewell/streamly). Join the
603+[on github](https://github.com/composewell/streamly). Join the [gitter
605−[gitter chat](https://gitter.im/composewell/streamly) channel for discussions.
604+chat](https://gitter.im/composewell/streamly) channel for discussions. Please
606−You can find some of the
607−[todo items on the github wiki](https://github.com/composewell/streamly/wiki/Things-To-Do).
608−Please ask on the gitter channel or [contact the maintainer directly](mailto:harendra.kumar@gmail.com)
605+ask any questions on the gitter channel or [contact the maintainer
609−for more details on each item. All contributions are welcome!
606+directly](mailto:harendra.kumar@gmail.com). All contributions are welcome!