Update documentation

This commit is contained in:
Joel Stanley 2021-06-29 13:45:49 -05:00
parent a3414fe146
commit ea34dd70e5
No known key found for this signature in database
GPG Key ID: F368244CDC80C97F

View File

@ -7,7 +7,7 @@ have extended and released under the same [`LICENSE`](./LICENSE)
Installation
------------
**The current version of this library requires gRPC version 1.2.0. Newer versions may work but have not been tested.**
**The current version of this library requires gRPC version 1.34.1. Newer versions may work, but have not been tested.**
Usage
-----
@ -24,9 +24,15 @@ testing:
```bash
$ nix-shell
[nix-shell]$ cabal configure --enable-tests && cabal build && cabal test
...
Running: cabal configure --extra-include-dirs ... --extra-lib-dirs ... --enable-tests
...
[nix-shell]$ cabal build && cabal test
```
Note that `cabal configure` is run automatically upon `nix-shell` entry so that
the build can reference include and library paths for the `grpc` library.
Using the Library
-----------------