Add comprehensive README with project overview and documentation

- Beautiful markdown formatting with badges and sections
- Complete feature overview and technical details
- Data quality statistics and key insights
- Development instructions and contribution guidelines
- Proper attribution and licensing information
- Easy navigation with clear structure and emojis

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Johan Lundberg 2025-07-01 00:41:07 +02:00
parent ceaa845127
commit 6943b2065a

132
README.md Normal file
View file

@ -0,0 +1,132 @@
# 🎵 Rolling Stone's Top 500 Albums
A beautiful, interactive web application showcasing Rolling Stone's greatest albums of all time with visual comparisons between the 2020 and 2023 rankings.
![Top 500 Albums](https://img.shields.io/badge/Albums-500-brightgreen)
![Data Complete](https://img.shields.io/badge/Data-100%25%20Complete-success)
![Cover Art](https://img.shields.io/badge/Cover%20Art-500%20Albums-blue)
## ✨ Features
- **Interactive Album Cards**: Browse all 500 albums with high-quality cover art
- **Ranking Comparisons**: See how albums moved between 2020 and 2023 rankings
- **Complete Metadata**: Full album information including artist, year, label, and descriptions
- **Responsive Design**: Beautiful layout that works on all devices
- **Search & Filter**: Easy navigation through the extensive collection
## 🚀 Live Demo
Open `index.html` in your browser to explore the collection, or serve it locally:
```bash
python -m http.server 8000
# Then visit http://localhost:8000
```
## 📊 Data Sources
- **2020 Rankings**: Rolling Stone's original 500 Greatest Albums list
- **2023 Rankings**: Updated rankings from Rolling Stone's revised list
- **Album Information**: Comprehensive metadata including release info and descriptions
- **Cover Art**: High-quality album artwork sourced from iTunes API
## 🎨 What's Included
### Core Files
- `index.html` - Main web application
- `styles.css` - Beautiful, responsive styling
- `script.js` - Interactive functionality
- `favicon.svg` - Custom music note favicon
### Data Files
- `top_500_albums_2023.csv` - Complete dataset with 100% metadata coverage
- `rolling_stone_top_500_albums_2020.csv` - Original 2020 rankings
- `wikipedia_top_500_albums.csv` - Wikipedia sourced data for comparison
### Assets
- `covers/` - 500 high-quality album cover images (rank_XXX_Artist_Album.jpg)
### Utilities
- `scripts/` - Python scripts for data processing and maintenance
## 🛠️ Scripts
The repository includes various Python utilities for data management:
| Script | Purpose |
|--------|---------|
| `compare_top500_albums.py` | Generate the main comparison dataset |
| `merge_descriptions.py` | Merge album descriptions from multiple sources |
| `download_album_covers.py` | Download album artwork from iTunes API |
| `add_missing_info.py` | Add metadata for albums missing information |
| `fill_missing_from_wikipedia.py` | Research and add Wikipedia-sourced descriptions |
## 📈 Data Quality
- **500/500 albums** with complete ranking information
- **500/500 albums** with cover art
- **500/500 albums** with metadata (artist, album, year, label)
- **500/500 albums** with descriptions (mix of original Rolling Stone content and researched additions)
## 🎯 Key Insights
### Notable Changes (2020 → 2023)
- **Biggest Climber**: Lauryn Hill's "The Miseducation of Lauryn Hill" (#10 in 2023, previously much lower)
- **New Entries**: Recent albums like Beyoncé's "Renaissance" and Bad Bunny's "Un Verano Sin Ti"
- **Genre Diversity**: Increased representation of hip-hop, R&B, and global music
### Statistics
- **Most Represented Artist**: The Beatles (multiple albums in top rankings)
- **Decades Covered**: 1950s through 2020s
- **Genres**: Rock, Hip-Hop, R&B, Soul, Punk, Electronic, Country, Jazz, and more
## 🔧 Technical Details
### Frontend
- **Vanilla JavaScript** for maximum compatibility
- **CSS Grid & Flexbox** for responsive layouts
- **Progressive Enhancement** for accessibility
### Data Processing
- **Python 3** scripts for data manipulation
- **CSV format** for easy data management
- **iTunes API** integration for cover art
- **Fuzzy string matching** for data correlation
## 📝 Development
### Running Locally
1. Clone the repository
2. Open `index.html` in a web browser
3. For development with live reload, use any local server
### Adding New Data
1. Update the CSV files with new information
2. Run appropriate scripts from the `scripts/` folder
3. Regenerate cover art if needed using download scripts
### Contributing
- All album descriptions marked "(by Claude)" were AI-generated based on historical research
- Original Rolling Stone descriptions preserved where available
- Cover art sourced from iTunes API with proper attribution
## 📜 License
This project is for educational and research purposes. Album artwork and descriptions are used under fair use for educational commentary and criticism.
- **Rolling Stone rankings**: © Rolling Stone Magazine
- **Album artwork**: © Respective record labels and artists
- **Code and compilation**: Open source
## 🙏 Acknowledgments
- **Rolling Stone Magazine** for the original rankings and descriptions
- **iTunes API** for high-quality album artwork
- **Wikipedia contributors** for additional album research
- **Claude AI** for data processing assistance and missing descriptions
---
*Explore the greatest albums of all time and discover how musical tastes and recognition have evolved between 2020 and 2023.*
🎧 **[Start Exploring →](index.html)**