Skip to content

Add shields.io badges to README and create MIT LICENSE file #120

Description

@sebastientaggart

Problem to Fix

The repository has no LICENSE file despite claiming MIT licensing, and the README lacks the trust-signal badges that open-source visitors expect (CI status, license, version, activity, tech stack).

Why it Matters

Missing a LICENSE file creates legal ambiguity for potential adopters — without one, the code is technically "all rights reserved." Missing badges make the project look less professional and maintained, reducing the likelihood that developers will trust and adopt it.

General Approach

Create a proper MIT LICENSE file, add a curated set of shields.io badges to the top of the README (CI status, license, release version, last commit, PRs welcome, Shell/Bash tech stack, Git Submodule install method), and update the License section at the bottom to link to the new file.

Complexity

Verification / QA effort: trivial
Visual check of the README rendering on GitHub and confirmation that the LICENSE file exists and displays correctly.

Acceptance Criteria

  • A standard MIT LICENSE file exists at the repository root
  • The README displays 7 shields.io badges below the header image: CI, License, Release, Last Commit, PRs Welcome, Shell/Bash, Git Submodule
  • All badge links resolve correctly and render on GitHub
  • The License section at the bottom of the README links to the LICENSE file

Metadata

Metadata

Labels

documentationImprovements or additions to documentationqa-passedQA completed, passes

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions