From bb78577c2704fd9479d12a1af2f6c3488a367809 Mon Sep 17 00:00:00 2001 From: Christopher Crone Date: Tue, 17 Mar 2020 11:39:03 +0100 Subject: [PATCH] Rework README Signed-off-by: Christopher Crone --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2ff998a..0001f24 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,14 @@ # Compose Specification Reference Implementation +![Continuous integration](https://github.com/compose-spec/compose-ref/workflows/Continuous%20integration/badge.svg) ![logo](logo.png) -This project host the reference implementation of the Compose specification. It is not designed for production use -but to demonstrate implementation of Compose Specification on top of Docker API and offer a code base to experiment -with changes being proposed to the Compose Specification. +This repository hosts the reference implementation for the Compose +specification. The purpose of this implementation is to provide a tool for +Compose specification contributors to test changes to the specification and a +code example for Compose specification implementers to understand how to +implement the specification. It is not intended to be used 'as is' by end users +or in production. -![Continuous integration](https://github.com/compose-spec/compose-ref/workflows/Continuous%20integration/badge.svg) \ No newline at end of file +Before creating an issue or submitting a contribution, please read the +[contributing guide](CONTRIBUTING.md).