Skip to content

docs: modernize README with clean hero, client badges, and native mermaid architecture - #16

Merged
engkinandatama merged 3 commits into
CORE-Lab-Research:mainfrom
engkinandatama:docs/enhance-readme-and-architecture
Sep 29, 2026
Merged

engkinandatama merged 3 commits into
CORE-Lab-Research:mainfrom
engkinandatama:docs/enhance-readme-and-architecture

Conversation

@engkinandatama

Copy link
Copy Markdown
Collaborator

Visual & Architectural Enhancement for README

Changes

  • Enlarged Logo: Image width adjusted to 380px with redundant # BioContext text removed (logo already contains the typography).
  • Refined Badges:
    • Removed personal ORCID from top badges (retained in academic citation metadata).
    • Added dedicated AI client support badges: Cursor, Claude Desktop & Code, Antigravity IDE, and Goose.
    • Retained PyPI, Zenodo DOI, Python versions, CI/CD, License, and MCP 2.x badges.
  • Native Mermaid Architecture:
    • Replaced monospace ASCII box diagram with clean, responsive GitHub-native Mermaid graph with colored subsystem nodes.
    • Renders perfectly on both light and dark GitHub themes without font misalignment or breaking in PyPI.

@engkinandatama
engkinandatama merged commit ff93d29 into CORE-Lab-Research:main Sep 29, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant