[snowpatch] [PATCH v2 5/6] README.md: Add information about project status and documentation

[Andrew Donnellan]

Signed-off-by: Andrew Donnellan <andrew.donnellan at au1.ibm.com>
---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.md b/README.md
index f69402635d4d..d03be5d56bc8 100644
--- a/README.md
+++ b/README.md
@@ -42,6 +42,18 @@ snowpatch is named in honour of
 creation of snowpatch.
 
 
+Project Status
+--------------
+
+snowpatch is currently under heavy development. It implements enough core
+functionality to be useful for basic CI requirements, and is currently deployed
+in production for a small number of projects. There are many core features that
+are still yet to be implemented, and documentation is still incomplete.
+
+At this stage, there are no stability guarantees, and behaviour is liable to
+change significantly in new versions without notice.
+
+
 Installing
 ----------
 
@@ -72,6 +84,16 @@ To compile snowpatch manually, clone the git repository and run `cargo build
 executed using `cargo run`.
 
 
+Documentation
+-------------
+
+For usage information, run `snowpatch --help`.
+
+Example configurations can be found in the [`examples`](examples) directory.
+
+Additional documentation can be found in the [`docs`](docs) directory.
+
+
 Contributing
 ------------
 
-- 
2.11.0