Skip to content

Commit ff7fb7b

Browse files
committed
Added some badges to the README.
1 parent 5a74a56 commit ff7fb7b

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

.github/workflows/run-tests.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# This workflow will install Python dependencies, run tests and lint with a single version of Python
22
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
33

4-
name: Test the library
4+
name: Unit tests
55

66
on:
77
push:

README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,12 @@
1212

1313
# Python client for the gobbler service
1414

15-
Pretty much as it says on the tin; provides an Python client for the [Gobbler service](https://github.com/ArtifactDB/gobbler),
16-
as a sister package to the corresponding [R client](https://github.com/ArtifactDB/gobbler-R).
15+
![Unit tests](https://github.com/ArtifactDB/gobbler-py/actions/workflows/run-tests.yaml/badge.svg)
16+
![Documentation](https://github.com/ArtifactDB/gobbler-py/actions/workflows/build-docs.yaml/badge.svg)
17+
18+
Pretty much as it says on the tin; provides an Python client for the [Gobbler service](https://github.com/ArtifactDB/gobbler).
19+
It is assumed that the users of this package and the Gobbler service itself are accessing the same shared filesystem;
20+
this is typically the case for high-performance computing (HPC) clusters in scientific institutions.
1721
To demonstrate, let's spin up a mock Gobbler instance:
1822

1923
```python

0 commit comments

Comments
 (0)