summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2019-12-01 10:32:22 +0200
committerLars Wirzenius <liw@liw.fi>2019-12-01 10:32:22 +0200
commit5d1fe2fab365af65ee4c36e1f61501983f98d177 (patch)
treec2245b8b8fc6ab48f1703b2bda4cb3243d740847
parentc37e13bcf4219771f0895988e66f0619891d3e77 (diff)
downloadsubplot-5d1fe2fab365af65ee4c36e1f61501983f98d177.tar.gz
Change: update README to be a little clearer
Also, rename to README.md so code hosting sites render it as HTML.
-rw-r--r--README.md (renamed from README)11
1 files changed, 9 insertions, 2 deletions
diff --git a/README b/README.md
index 852f615..ccbb52b 100644
--- a/README
+++ b/README.md
@@ -1,6 +1,13 @@
-NB. Subplot is very much not finished and is not usable yet.
+# Subplot
-# When all stakeholders really need to understand acceptance criteria
+Document acceptance criteria of software and systems, and how they are
+verified.
+
+**Status:** Subplot is very much not finished and is not usable yet.
+We're working on a minimum viable product which can be used for a
+simple web API project.
+
+## When all stakeholders really need to understand acceptance criteria
Subplot is a set of tools for specifying, documenting, and
implementing automated acceptance tests for systems and software.