Skip to content

Update README branding and add example usage demo - #41

Merged
harryswift01 merged 2 commits into
mainfrom
40-remove-duplicated-logo-from-readmemd
Oct 16, 2026
Merged

harryswift01 merged 2 commits into
mainfrom
40-remove-duplicated-logo-from-readmemd

Conversation

@harryswift01

Copy link
Copy Markdown
Member

Summary

This PR updates the README.md layout and branding to remove the duplicated logo, correct the logo file paths, and provide a clearer example usage section with a demo.

Changes

Remove duplicated logo and correct logo paths

  • Removed the standalone logo previously displayed at the top of the README.
  • Retained the light and dark mode logo variants.
  • Corrected the logo paths to reference their new location under docs/source/_static/logos/.
  • Reordered the README heading and logo placement for a cleaner layout.

Re-added example usage demo

  • Repositioned the Example usage section within the README.
  • Added a demo showing prepmd in use.

Impact

  • Removes the duplicated logo from the README.
  • Ensures the correct light and dark mode logos are displayed.
  • Provides a visual demonstration of prepmd usage.

@harryswift01 harryswift01 self-assigned this Sep 7, 2026
@harryswift01 harryswift01 added the documentation Improvements or additions to documentation label Sep 7, 2026
@harryswift01 harryswift01 linked an issue Sep 7, 2026 that may be closed by this pull request
@harryswift01 harryswift01 changed the title 40 remove duplicated logo from readmemd Update README branding and add example usage demo Sep 7, 2026
@harryswift01
harryswift01 requested a review from jimboid October 16, 2026 14:33

@jimboid jimboid left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

@harryswift01
harryswift01 merged commit 1560ea7 into main Oct 16, 2026
5 checks passed
@harryswift01
harryswift01 deleted the 40-remove-duplicated-logo-from-readmemd branch October 16, 2026 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove duplicated logo from README.md

2 participants