From ea34dd70e5edca559f993105f3ea505716cea7f3 Mon Sep 17 00:00:00 2001 From: Joel Stanley Date: Tue, 29 Jun 2021 13:45:49 -0500 Subject: [PATCH] Update documentation --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f2ada28..14d7691 100644 --- a/README.md +++ b/README.md @@ -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 -----------------