[2/2] README.md: Add information about project status and documentation
diff mbox series

Message ID 20180723061721.31689-2-andrew.donnellan@au1.ibm.com
State Superseded
Headers show
Series
  • [1/2] README.md: Update installation instructions
Related show

Commit Message

Andrew Donnellan July 23, 2018, 6:17 a.m. UTC
Signed-off-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com>
---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

Patch
diff mbox series

diff --git a/README.md b/README.md
index 4a0f3e9d8c21..257ace39bb0c 100644
--- a/README.md
+++ b/README.md
@@ -39,6 +39,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
 ----------
 
@@ -69,6 +81,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
 ------------