@@ -1,15 +1,15 @@
11# Using `streamly` package
22
3−The latest stable release of the package is available
4−[on Hackage](https://hackage.haskell.org/package/streamly). You can also try
5−the latest development version
6−[from github](https://github.com/composewell/streamly).
3+* [Latest stable release](https://hackage.haskell.org/package/streamly) is available on
4+ Hackage.
5+* [Latest development version](https://github.com/composewell/streamly) is
6+ available on github.
7+* See [recommeded compilation options here](docs/Build.md).
78
8−The default version available to you and how to pick a specific version may
9−depend on the build tool you are using. We have provided instructions to use a
10−specific version for some tools below.
9+If you are using `stack` or `nix` please make sure to add the latest version
10+from Hackage to your tool configuration.
1111
12−## cabal
12+## Using with `cabal`
1313
1414Make sure you have `cabal` version 2.4 or later installed and you have `ghc`
1515available in your PATH. Refresh your package list:
@@ -18,19 +18,20 @@ available in your PATH. Refresh your package list:
1818$ cabal v2-update
1919```
2020
21−### hackage version in repl
21+### Using hackage version in repl
2222
2323```
24−# Pick the latest version on Hackage
24+# Run repl with the latest version from Hackage
2525$ cabal v2-repl --build-depends streamly
2626
27−# Pick a specific version on Hackage
27+# Run repl with a specific version from Hackage
2828$ cabal v2-repl --build-depends streamly==0.6.1
2929```
3030
31−### github version in repl
31+### Using github version in repl
3232
33−Create a `test` directory and create a `cabal.project` file in it as follows:
33+Create a directory for your playground (e.g. `test`) and create a
34+`cabal.project` file in it as follows:
3435
3536```
3637packages: .
@@ -40,7 +41,7 @@ source-repository-package
4041 tag: master
4142```
4243
43−Create a `test.cabal` file as follows
44+Create a cabal file (e.g. `test.cabal`) as follows
4445
4546```
4647cabal-version: 2.4
@@ -57,7 +58,7 @@ Run repl:
5758$ cabal v2-repl
5859```
5960
60−### ghc
61+### Compiling with ghc
6162
6263```
6364$ cat hello.hs
@@ -71,7 +72,7 @@ $ cabal v2-install streamly-0.6.1
7172$ ghc -package streamly-0.6.1 hello.hs
7273```
7374
74−### Project
75+### Using in a Project
7576
7677Add `streamly` to the `build-depends` section of your library/executable in
7778your `<package>.cabal` file. Appropriate version from Hackage will be picked