Update READMEs

.github/workflows/ci-nix.yaml

@@ -7,6 +7,11 @@ on:
     branches:
     - master
 
+
+permissions:
+  checks: write
+  pull-requests: write
+
 jobs:
   devour-flake:
     name: "Devour Flake"

README.md

@@ -1,14 +1,28 @@
 # grapesy-etcd
 
-Repository containing the [grapesy-etcd](grapesy-etcd/) client.
+This repository contains a [grapesy](https://hackage.haskell.org/package/grapesy) client
+for [etcd](http://etcd.io).
 
-## Building
+It is divided into two packages
+
+* [grapesy-etcd](grapesy-etcd/) - Contains the library code and protocol buffer bindings, released to hackage under [grapesy-etcd](https://hackage.haskell.org/package/grapesy-etcd).
+* [grapesy-etcd-testing](grapesy-etcd-testing) - Contains an executable (not cabal test) for running a test against a live etcd service.
+
+## Development
+
+Do this to get started.
 
 ```
 nix develop
 cabal build all
 ```
 
+## Testing
+
+Testing the must be done against a real etcd service, which is provided by a NixOS VM test in a flake check attribute. To run all of the tests, run
+
 ```
-cabal run grapesy-etcd
+nix flake check
 ```
+
+You may run the test executable against a version of etcd installed on your host if you wish.

grapesy-etcd-testing/CHANGELOG.md

@@ -1,6 +1,5 @@
-# ChangeLog for grapesy-etc
+# ChangeLog for grapesy-etc-testing
 
 ## 0.1.0
 
-* Initial version of grapesy-etc client. Contains full bindings to the etcdv3 spec as defined in
-rpc.proto.
+* Initial version of grapesy-etc-testing client. Runs a non-streaming call to `put` and a bidirectional streaming call to `watch`.

grapesy-etcd-testing/README.md

@@ -1,3 +1,3 @@
-# grapesy-etcd
+# grapesy-etcd-testing
 
-[grapesy](https://hackage.haskell.org/grapesy) client for [etcd](https://etcd.io/).
+Testing client executable for [grapesy-etcd](https://hackage.haskell.org/package/grapesy-etcd).