docs(README): improve the README (#38)

Update the README badges' layout and fix other minor documentation
issues and improvements. Also, document how to install the library.

.releaserc.yml

@@ -27,6 +27,16 @@ plugins:
               hasChanged: true
               numMatches: 1
               numReplacements: 1
+        - countMatches: true
+          files:
+            - README.md
+          from: 'sghi-etl-commons.git@v.*'
+          to: 'sghi-etl-commons.git@v${nextRelease.version}'
+          results:
+            - file: README.md
+              hasChanged: true
+              numMatches: 1
+              numReplacements: 1
   - - '@semantic-release/changelog'
     - changelogFile: docs/CHANGELOG.md
   - - '@semantic-release/git'

README.md

@@ -1,31 +1,23 @@
 <h1 align="center" style="border-bottom: none; text-align: center;">SGHI ETL Commons</h1>
 <h3 align="center" style="text-align: center;">Collection of utilities for working with SGHI ETL Workflows.</h3>
-<p align="center" style="text-align: center;">
-    <img alt="Python Version from PEP 621 TOML" src="https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fsavannahghi%2Fsghi-etl-commons%2Fdevelop%2Fpyproject.toml&logo=python&labelColor=white">
-    <a href="https://microsoft.github.io/pyright/">
-        <img alt="Checked with pyright" src="https://microsoft.github.io/pyright/img/pyright_badge.svg">
-    </a>
-    <a href="https://github.com/astral-sh/ruff">
-        <img alt="Ruff" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json">
-    </a>
-    <a href="https://github.com/pre-commit/pre-commit">
-        <img alt="pre-commit" src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white">
-    </a>
-    <a href="https://github.com/semantic-release/semantic-release">
-        <img alt="Semantic Release: conventionalcommits" src="https://img.shields.io/badge/semantic--release-conventionalcommits-e10079?logo=semantic-release"/>
-    </a>
-    <a href="https://github.com/savannahghi/sghi-etl-commons/blob/develop/LICENSE">
-        <img alt="GitHub License" src="https://img.shields.io/badge/License-MIT-blue.svg">
-    </a>
-</p>
-<p align="center" style="text-align: center;">
-    <a href="https://github.com/savannahghi/sghi-etl-commons/actions/workflows/ci.yml">
-        <img alt="CI" src="https://github.com/savannahghi/sghi-etl-commons/actions/workflows/ci.yml/badge.svg">
-    </a>
-    <a href="https://coveralls.io/github/savannahghi/sghi-etl-commons?branch=develop">
-        <img alt="Coverage Status" src="https://img.shields.io/coverallsCoverage/github/savannahghi/sghi-etl-commons?branch=develop&logo=coveralls">
-    </a>
-</p>
+
+<div align="center" style="text-align: center;">
+
+![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fsavannahghi%2Fsghi-etl-commons%2Fdevelop%2Fpyproject.toml&logo=python&labelColor=white)
+[![Checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
+[![Semantic Release: conventionalcommits](https://img.shields.io/badge/semantic--release-conventionalcommits-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
+[![GitHub License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/savannahghi/sghi-etl-commons/blob/develop/LICENSE)
+
+</div>
+
+<div align="center" style="text-align: center;">
+
+[![CI](https://github.com/savannahghi/sghi-etl-commons/actions/workflows/ci.yml/badge.svg)](https://github.com/savannahghi/sghi-etl-commons/actions/workflows/ci.yml)
+[![Coverage Status](https://img.shields.io/coverallsCoverage/github/savannahghi/sghi-etl-commons?branch=develop&logo=coveralls)](https://coveralls.io/github/savannahghi/sghi-etl-commons?branch=develop)
+
+</div>
 
 ---
 
@@ -34,6 +26,22 @@ projects. Specifically, this is a collection of common implementations of the
 interfaces defined by the [sghi-etl-core](https://github.com/savannahghi/sghi-etl-core/)
 project as well as other useful utilities.
 
+## Getting Started
+
+`sghi-etl-commons` supports Python 3.11+.
+
+To install the latest stable release, use:
+
+```shell
+pip install sghi-etl-commons@git+https://github.com/savannahghi/sghi-etl-commons.git@v1.1.0
+```
+
+To install the latest development version, use:
+
+```shell
+pip install sghi-etl-commons@git+https://github.com/savannahghi/sghi-etl-commons.git@develop
+```
+
 ## Contribute
 
 Clone the project and run the following command to install dependencies: