Skip to content

Commit 6d9d414

Browse files
authored
Enhance README with badges and Docker instructions
Updated README to include additional badges and clarify Docker usage.
1 parent 5d90d5f commit 6d9d414

1 file changed

Lines changed: 19 additions & 7 deletions

File tree

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,32 @@
11
# CCPBioSim Basic Analysis Workshop
22

3-
[![build](https://github.com/ccpbiosim/basic-analysis-workshop/actions/workflows/build.yaml/badge.svg?branch=main)](https://github.com/ccpbiosim/basic-analysis-workshop/actions/workflows/build.yaml)
3+
[basic-analysis](https://github.com/ccpbiosim/basic-analysis-workshop)
4+
[![ci](https://github.com/ccpbiosim/basic-analysis-workshop/actions/workflows/build.yaml/badge.svg?branch=main)](https://github.com/ccpbiosim/basic-analysis-workshop/actions/workflows/build.yaml)
5+
[![latest](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fccpbiosim.github.io%2Fworkshop.json&query=%24.containers.basic-analysis-workshop.latest&labelColor=grey&logo=github&logoColor=white&label=latest&color=purple)](https://github.com/ccpbiosim/basic-analysis-workshop/pkgs/container/basic-analysis-workshop)
6+
[![issues](https://img.shields.io/github/issues/ccpbiosim/basic-analysis-workshop?logo=github&labelColor=grey)](https://github.com/CCPBioSim/basic-analysis-workshop/issues)
7+
[![pr](https://img.shields.io/github/issues-pr/ccpbiosim/basic-analysis-workshop?logo=github&labelColor=grey)](https://github.com/CCPBioSim/basic-analysis-workshop/pulls)
48

5-
## Docker
6-
7-
This container is derived from the CCPBioSim JupyterHub image. This container
8-
adds the necessary software packages and notebook content to form a deployable
9-
course container. The source content for this course can be found at
10-
https://github.com/CCPBioSim/basic-analysis-workshop
9+
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.
1110

1211
## How to Use
1312

13+
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.
14+
15+
Pull the container from our repository::
16+
17+
docker pull ghcr.io/ccpbiosim/basic-analysis-workshop:latest
18+
1419
In our containers we are using the JupyterHub default port 8888, so you should
1520
forward this port when deploying locally::
1621

1722
docker run -p 8888:8888 ghcr.io/ccpbiosim/basic-analysis-workshop:latest
1823

24+
## Authors
25+
26+
Workshop Content Authors:
27+
28+
- Charlie Laughton
29+
1930
## Contact
31+
2032
Please direct all questions and feedback to [Charlie Laughton](mailto:charles.laughton@nottingham.ac.uk)

0 commit comments

Comments
 (0)