Skip to content

improve readme: add gssoc banner and project insights #27

@itspavant

Description

@itspavant

📖 Description

I would like to improve the README.md by adding:

  • A GSSoC acceptance banner
  • A new Project Insights section displaying real-time repository statistics

This will highlight that CircleOfInterest is officially part of GSSoC 2025 and provide contributors with quick project insights.
The statistics will be powered by Shields.io badges (stars, forks, issues, PRs, contributors, languages, etc.), which auto-update without needing API tokens.

✅ Benefits

  • Makes the README visually attractive (banner + logo).
  • Displays live project activity (stars, forks, issues, PRs, contributors).
  • Emphasizes participation in GSSoC '25.
  • Helps onboard and motivate new contributors by showing project health.

💡 Proposed Changes

  • Add assets/logo.png and assets/gssoc-banner.png to the repository.
  • Update the README to include:
    • Banner at the top
    • Logo near the project title
    • A Project Insights section with Shields.io badges
  • Use temporary image links from the fork in the PR, and update to canonical repo URLs after merge.

📸 Preview (Example)

Here’s how it could look, with project logo and name above this section:

Image

🙋 Contributor

I am a GSSoC '25 contributor and would like to work on this enhancement.

🏷️ Labels

enhancement documentation gssoc25

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions