Merge pull request #23 from CCPBioSim/jimboid-patch-1

Revise README with badges and usage instructions

Author: jimboid

README.md

@@ -1,17 +1,31 @@
-CCPBioSim Structure Validation Workshop
-=======================================
+# CCPBioSim Structure Validation Workshop
 
-[![build](https://github.com/ccpbiosim/structure-validation-workshop/actions/workflows/build.yaml/badge.svg?branch=main)](https://github.com/ccpbiosim/structure-validation-workshop/actions/workflows/build.yaml)
+[![ci](https://github.com/ccpbiosim/structure-validation-workshop/actions/workflows/build.yaml/badge.svg?branch=main)](https://github.com/ccpbiosim/structure-validation-workshop/actions/workflows/build.yaml)
+[![latest](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fccpbiosim.github.io%2Fworkshop.json&query=%24.containers.structure-validation-workshop.latest&labelColor=grey&logo=github&logoColor=white&label=latest&color=purple)](https://github.com/ccpbiosim/structure-validation-workshop/pkgs/container/structure-validation-workshop)
+[![issues](https://img.shields.io/github/issues/ccpbiosim/structure-validation-workshop?logo=github&labelColor=grey)](https://github.com/CCPBioSim/structure-validation-workshop/issues)
+[![pr](https://img.shields.io/github/issues-pr/ccpbiosim/structure-validation-workshop?logo=github&labelColor=grey)](https://github.com/CCPBioSim/structure-validation-workshop/pulls)
 
-This container is derived from the CCPBioSim JupyterHub image. This container
-adds the necessary software packages and notebook content to form a deployable
-course container. The source content for this course can be found at
-https://github.com/CCPBioSim/structure-validation-workshop
+This workshop source repository contains the build recipe for a docker container derived from the CCPBioSim JupyterHub image. This container adds the necessary software packages and notebook content to form a deployable course container.
 
-How to Use
-----------
+## How to Use
+
+This training course is deployed on the [CCPBioSim](www.ccpbiosim.ac.uk) website via our cloud infrastructure, however you can deploy on your own machine with docker.
+
+Pull the container from our repository::
+
+    docker pull ghcr.io/ccpbiosim/structure-validation-workshop:latest
 
 In our containers we are using the JupyterHub default port 8888, so you should
 forward this port when deploying locally::
 
     docker run -p 8888:8888 ghcr.io/ccpbiosim/structure-validation-workshop:latest
+
+## Authors
+
+Workshop Content Authors:
+
+- Martyn Winn
+
+## Contact
+
+Please direct all questions and feedback to [Charlie Laughton](mailto:martyn.winn@stfc.ac.uk)