Add long description for build tool compatibility

.github/workflows/unittesting.yml → .github/workflows/unittests.yml

@@ -1,27 +1,27 @@
-name: "Unittesting"
-
-on:
-  push:
-    branches:
-      - main
-  pull_request: {}
-jobs:
-  pytest:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        python-version: ["3.12"]
-        os: [ubuntu-latest]
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install tox
-      - name: Run unittests via tox
-        run: |
+name: "Unittests"
+
+on:
+  push:
+    branches:
+      - main
+  pull_request: {}
+jobs:
+  pytest:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Run unittests via tox
+        run: |
           tox -e testing

README.md

@@ -1 +1,18 @@
-# alloy
+<div align="center">
+
+# alloy
+
+CLI tool designed to consolidate codebases into a single markdown file.
+
+![Unittests status badge](https://github.com/OLILHR/alloy/workflows/Unittests/badge.svg)
+![Coverage status badge](https://github.com/OLILHR/alloy/workflows/Coverage/badge.svg)
+![Pylint status badge](https://github.com/OLILHR/alloy/workflows/Linting/badge.svg)
+![Formatting status badge](https://github.com/OLILHR/alloy/workflows/Formatting/badge.svg)
+
+</div>
+
+### Installation
+
+```sh
+pip install
+```