Reorganize with YAML configs for dual dataset support

README.md

@@ -15,6 +15,11 @@ language:
 - en
 size_categories:
 - 1K<n<10K
+configs:
+- config_name: yearly
+  data_files: "yearly/data.csv"
+- config_name: full
+  data_files: "full/data.csv"
 ---
 
 # GitHub Top Developers by Year (2015-2025)
@@ -30,6 +35,42 @@ A derived dataset showing the top-ranked GitHub trending developers for each yea
 - **Data Order**: Sorted by year (descending: 2025 → 2015) and rank within each year
 - **Update Frequency**: Static historical dataset
 
+## 🔧 Dataset Configurations
+
+This dataset has **two configurations** defined in the YAML header:
+
+### Configuration: `yearly` (Default)
+Top-ranked developers by year with 8,125 entries
+
+```python
+from datasets import load_dataset
+ds = load_dataset('ronantakizawa/github-top-developers', 'yearly')
+```
+
+**Columns:**
+- `year` (int): Year (2015-2025)
+- `rank` (int): Overall rank for that year (1 = highest score)
+- `name` (string): Developer/organization GitHub username
+- `times_trended` (int): Number of times appeared on trending
+- `best_rank` (int): Highest rank achieved (lowest number)
+- `avg_rank` (float): Average rank across all appearances
+- `median_rank` (int): Median rank
+- `popular_repos` (string): Top repositories (comma-separated)
+
+### Configuration: `full`
+Complete daily trending data with 41,841 entries
+
+```python
+from datasets import load_dataset
+ds = load_dataset('ronantakizawa/github-top-developers', 'full')
+```
+
+**Columns:**
+- `name` (string): Developer/organization GitHub username
+- `rank` (int): Position in trending (1-25)
+- `popular_repo` (string): Associated repository at the time
+- `date` (string): Snapshot date (YYYY-MM-DD)
+
 ## 🏆 Scoring Methodology
 
 Each developer's yearly score is calculated using:
@@ -49,21 +90,6 @@ Where:
 - ✅ Rewards **high rankings** (rank 1 is worth more than rank 25. We use 25 because github ranks the top 25 developers on their page)
 - ✅ Balances consistency with peak performance
 
-## 📋 Dataset Structure
-
-### Columns
-
-| Column | Type | Description |
-|--------|------|-------------|
-| `year` | integer | Year (2015-2025) |
-| `rank` | integer | Overall rank for that year (1 = highest score) |
-| `name` | string | Developer/organization GitHub username |
-| `times_trended` | integer | Number of times appeared on trending |
-| `best_rank` | integer | Highest rank achieved (lowest number) |
-| `avg_rank` | float | Average rank across all appearances |
-| `median_rank` | integer | Median rank |
-| `popular_repos` | string | Top repositories (comma-separated) |
-
 ## 🌟 Key Insights
 
 ### 1. Year Winners (Highest Score Each Year)
@@ -125,8 +151,68 @@ Where:
 - **Organization Decline**: Big tech companies dropped from top spots after 2019
 - **Ecosystem Impact**: Most top developers maintain influential open-source libraries
 
+## 💡 Usage Examples
+
+### Load with Hugging Face Datasets (Recommended)
+
+```python
+from datasets import load_dataset
+
+# Load yearly aggregated dataset (8,125 entries)
+ds_yearly = load_dataset('ronantakizawa/github-top-developers', 'yearly')
+df_yearly = ds_yearly['train'].to_pandas()
+
+# Load complete daily dataset (41,841 entries)
+ds_full = load_dataset('ronantakizawa/github-top-developers', 'full')
+df_full = ds_full['train'].to_pandas()
+
+# Get top 10 developers of 2024
+top_2024 = df_yearly[df_yearly['year'] == 2024].head(10)
+print(top_2024[['rank', 'name', 'times_trended', 'popular_repos']])
+```
+
+### Time Series Analysis
+
+```python
+import pandas as pd
+import matplotlib.pyplot as plt
+from datasets import load_dataset
+
+ds = load_dataset('ronantakizawa/github-top-developers', 'full')
+df = ds['train'].to_pandas()
+df['date'] = pd.to_datetime(df['date'])
+
+# Analyze a specific developer over time
+developer = 'emilk'
+dev_df = df[df['name'] == developer]
+
+# Plot trending frequency over time
+monthly_counts = dev_df.groupby(dev_df['date'].dt.to_period('M')).size()
+monthly_counts.plot(title=f'{developer} Trending Frequency')
+plt.ylabel('Days in Trending')
+plt.show()
+```
+
+## 📖 Citation
+
+If you use this dataset in your research, please cite:
+
+```bibtex
+@dataset{github_trending_developers_2015_2025,
+  title={GitHub Top Developers Dataset (2015-2025)},
+  author={Ronan Takizawa},
+  year={2025},
+  publisher={Hugging Face},
+  url={https://huggingface.co/datasets/ronantakizawa/github-top-developers}
+}
+```
+
 ## 📄 License
 
 MIT License - Free to use with attribution
 
+---
 
+**Last Updated:** December 2025
+**Dataset Version:** 1.0
+**Status:** ✅ Complete and ready for use