From: Stephen Rosen <sirosen@globus.org>
Date: Mon, 20 May 2019 17:57:09 +0000 (-0400)
Subject: Add doc clarifying that there is no blackd client (#859)
X-Git-Url: https://git.madduck.net/etc/vim.git/commitdiff_plain/a4399f3054206eac52a89832a415e31077bafa0a?ds=sidebyside;pf=etc

Add doc clarifying that there is no blackd client (#859)

Resolves #854

The first sentence of this is pretty uncontroversial. (Though I wasn't
sure exactly where in the text to put it.)
I thought it would also be nice to show the `curl` test with a tiny
statement that actually reformats.
---

diff --git a/README.md b/README.md
index aa2d059..ead7b61 100644
--- a/README.md
+++ b/README.md
@@ -844,6 +844,14 @@ Options:
   -h, --help                      Show this message and exit.
 ```
 
+There is no official blackd client tool (yet!). You can test that blackd is
+working using `curl`:
+
+```
+blackd --bind-port 9090 &  # or let blackd choose a port
+curl -s -XPOST "localhost:9090" -d "print('valid')"
+```
+
 ### Protocol
 
 `blackd` only accepts `POST` requests at the `/` path. The body of the request