From 107c6847fb6401da5dff30b4a158d505500097f4 Mon Sep 17 00:00:00 2001 From: James Gebbie-Rayet Date: Thu, 15 Jan 2026 13:35:59 +0000 Subject: [PATCH] Enhance README with updated badges and Docker info Updated badges and improved Docker section for clarity. --- README.md | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c1d5369..1b1e6e7 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,31 @@ # CCPBioSim Clustering Workshop -[![build](https://github.com/ccpbiosim/clustering-workshop/actions/workflows/build.yaml/badge.svg?branch=main)](https://github.com/ccpbiosim/clustering-workshop/actions/workflows/build.yaml) +[![ci](https://github.com/ccpbiosim/clustering-workshop/actions/workflows/build.yaml/badge.svg?branch=main)](https://github.com/ccpbiosim/clustering-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.clustering-workshop.latest&labelColor=grey&logo=github&logoColor=white&label=latest&color=purple)](https://github.com/ccpbiosim/clustering-workshop/pkgs/container/clustering-workshop) +[![issues](https://img.shields.io/github/issues/ccpbiosim/clustering-workshop?logo=github&labelColor=grey)](https://github.com/CCPBioSim/clustering-workshop/issues) +[![pr](https://img.shields.io/github/issues-pr/ccpbiosim/clustering-workshop?logo=github&labelColor=grey)](https://github.com/CCPBioSim/clustering-workshop/pulls) -## Docker - -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/clustering-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 +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/clustering-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/clustering-workshop:latest +## Authors + +Workshop Content Authors: + +- Charlie Laughton + ## Contact -Please direct all comments and queries to [Charlie Laughton](mailto:charles.laughton@nottingham.ac.uk) + +Please direct all questions and feedback to [Charlie Laughton](mailto:charles.laughton@nottingham.ac.uk)