Initial commit: luis_utils package with core functionality

Author: luis-marques

.github/workflows/ci.yml

@@ -79,4 +79,4 @@ jobs:
       uses: codecov/codecov-action@v5
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
-        slug: luis-marques/luis-utils
+        slug: luis-marques/luis_utils

README.md

@@ -1,6 +1,18 @@
-# Luis Utils
-![workflow](https://github.com/luis-marques/luis-utils/actions/workflows/ci.yml/badge.svg)
-[![codecov](https://codecov.io/gh/luis-marques/luis-utils/branch/main/graph/badge.svg)](https://codecov.io/gh/luis-marques/luis-utils)
+# Luis' Utils
+![workflow](https://github.com/luis-marques/luis_utils/actions/workflows/ci.yml/badge.svg)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
 
-Some basic shared utils.
+Some utils shared across various research projects during my PhD.<br>
+See [https://marquesluis.com](https://marquesluis.com) for news and to get in touch.
+
+## Installation
+
+```
+$ python -m venv venv
+$ source venv/bin/activate
+$ pip install -e ".[dev]"
+```
+
+## Acknowledgements
+
+This repo follows Tom Silver's [python-starter](https://github.com/tomsilver/python-starter) template.