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