summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2017-08-01 11:02:34 +0300
committerLars Wirzenius <liw@liw.fi>2017-08-01 11:02:34 +0300
commitce98d90c6c39390457011e7170f4150560e2c9a0 (patch)
treeae0438c34e24863f57fa206d7686b1b6beec6c3a
parent964b2e5a6e70c4a38bd98723e8f62a2d83e240e2 (diff)
downloadapifw-ce98d90c6c39390457011e7170f4150560e2c9a0.tar.gz
Add: explain lack of docs in README
-rw-r--r--README8
1 files changed, 8 insertions, 0 deletions
diff --git a/README b/README
index 221a7cc..f9ac9db 100644
--- a/README
+++ b/README
@@ -27,6 +27,14 @@ You will need [CoverageTestRunner][] and [yarn][].
[yarn]: https://liw.fi/cmdtest/
+Documentation
+-----------------------------------------------------------------------------
+
+There is no documentation yet. See the `apitest.py` file for a working
+example. The `apifw.yarn` test suite uses it, so see that for details
+on how to run program using the framework.
+
+
Legalese
-----------------------------------------------------------------------------