Skip to content

Readme file overhaul - #87

Open
hazzuk wants to merge 22 commits into
formattingfrom
readme
Open

hazzuk wants to merge 22 commits into
formattingfrom
readme

Conversation

@hazzuk

@hazzuk hazzuk commented Sep 4, 2026

Copy link
Copy Markdown
Owner

Description

Implements a more useful and visually pleasing README.md file.

Changes

  • Improvements to existing badges
  • Add REUSE API badge (relates to Implement REUSE spec compliance #90)
  • Add hits-of-code badge
  • Use HTML tags for better formatting
  • Add header image
  • Add detailed about section
  • Add repositories section
  • General tidy-up

Notes

Other sections will be added to the README in future.

Checklist

  • [n/a] Written documentation
  • [n/a] Linked relevant issues

@hazzuk hazzuk added the Kind/Documentation Documentation changes label Sep 4, 2026
@hazzuk
hazzuk requested a review from mosslocker September 4, 2026 20:27
@hazzuk

hazzuk commented Sep 4, 2026

Copy link
Copy Markdown
Owner Author

@mosslocker

When reviewing this, your thoughts and any feedback on the README's About section would be hugely beneficial.

@hazzuk
hazzuk requested a review from mosslocker September 7, 2026 22:16
@hazzuk

hazzuk commented Sep 7, 2026

Copy link
Copy Markdown
Owner Author

@mosslocker

I've made changes to the two paragraphs you provided feedback on. Both are now more specific with what they're trying to communicate. Please could you review again.

Also worth noting that as per your feedback, I started a write up for security. This has now become rather long and will be included at a later date as its own dedicated section.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Kind/Documentation Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants