Merge pull request #8 from zwicker-group/readme

Update README.md to include badges and enhance project description
zwicker-group · Jan 16, 2025 · 4ec807b · 4ec807b
2 parents 1b3ba36 + e7e3a06
commit 4ec807b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/.github/workflows/build.yml → .github/workflows/run_tests.yml b/.github/workflows/build.yml → .github/workflows/run_tests.yml
diff --git a/README.md b/README.md
@@ -1,5 +1,12 @@
 # utilitiez
-Collection of useful python tools.
+
+
+[![PyPI version](https://badge.fury.io/pyutilitiez.svg)](https://badge.fury.io/py/utilitiez)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+[![Build Status](https://github.com/zwicker-group/utilitiez/actions/workflows/run_tests.yml/badge.svg)](https://github.com/zwicker-group/utilitiez/actions/workflows/run_tests.yml)
+
+
+Collection of useful python tools used in the [Zwicker group](https://zwickergroup.org).
 
 So far, the only tool is the `densityplot` function, which provides a convenient way to
 produced density plots from simulated data, optionally involving logarithmically scaled