Skip to content

Conversation

@ajey35
Copy link

@ajey35 ajey35 commented Nov 19, 2025

docs: improve README — clearer overview, usage, and contribution notes

Description

This PR updates the existing README.md with a cleaner and more structured document.
The updated README:

  • Explains the repository’s purpose and high-level design
  • Adds quick links to data files, fetch scripts, the frontend, and workflows
  • Provides concise “Getting Started” steps for running fetch scripts and the Next.js frontend
  • Documents required environment variables / secrets and includes a sample data format
  • Adds contributor guidance, references, and a license pointer

Why this change

The previous README was terse and unstructured, making onboarding more difficult for contributors and maintainers.
This update improves clarity, reduces friction when running scripts locally, and clarifies how scheduled workflows and data files are organised.

Files changed

  • README.md

Notes for maintainer

If you prefer alternate phrasing or want additional examples (such as environment variable names, sample data output, screenshots, or workflow explanations), please indicate which sections should be expanded.

Suggested branch name: docs/improve-readme


Checklist

  • Clear summary and motivation
  • Getting-started instructions included
  • Data format and contribution guidance included

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