readme command group handles updating all README files from the listings.json data.
update
Update README files from listings.json.What it does
This command performs several operations:- Loads listings data - Reads
.github/scripts/listings.json - Validates schema - Ensures all required fields are present
- Sorts listings - Orders internships appropriately
- Filters by season - Separates Summer 2026 and off-season positions
- Generates README files:
README.md- Active Summer 2026 internships onlyREADME-Inactive.md- Inactive Summer 2026 internshipsREADME-Off-Season.md- Fall, Winter, and Spring positions
Listing categorization
Internships are automatically categorized into sections:- Software Engineering - Software development, full-stack, frontend, backend, mobile
- Product Management - Product manager, APM roles
- Data Science, AI & Machine Learning - Data science, ML, AI research
- Quantitative Finance - Quant trading, quant research
- Hardware Engineering - Hardware design, embedded systems, firmware
- Other - Tech-related internships that don’t fit above categories
Special indicators
The generated READMEs include visual indicators:- 🔥 FAANG+ companies - Google, Meta, Apple, Amazon, Microsoft, etc.
- 🎓 Advanced degree required - Master’s, MBA, or PhD
- 🛂 No sponsorship - Does not offer visa sponsorship
- 🇺🇸 U.S. citizenship required - Restricted to U.S. citizens
Example output
The generated README tables look like:| Company | Role | Location | Application | Age |
|---|---|---|---|---|
| Software Engineering Internship 🎓 | San Francisco, CA | Apply button | 2d |
GitHub Actions integration
This command is used in the “Update READMEs” workflow:commit_message with a timestamp for the commit message.
Related commands
- listings validate - Check data quality before updating
- listings stats - View statistics about listings