# GitHub README Research Dataset

**Use case:** 

Build a GitHub Trending dataset with repository metadata plus README content for documentation mining, market research, and AI datasets.

## Input

```json
{
  "language": "typescript",
  "since": "monthly",
  "spokenLanguageCode": "en",
  "aiOnly": false,
  "filterTopics": [
    "developer-tools",
    "automation"
  ],
  "includeReadme": true,
  "maxRepos": 15
}
```

## Output

```json
{
  "rank": {
    "label": "#",
    "format": "number"
  },
  "fullName": {
    "label": "Repository",
    "format": "text"
  },
  "description": {
    "label": "Description",
    "format": "text"
  },
  "language": {
    "label": "Language",
    "format": "text"
  },
  "stars": {
    "label": "Stars",
    "format": "number"
  },
  "forks": {
    "label": "Forks",
    "format": "number"
  },
  "starsToday": {
    "label": "Stars Today",
    "format": "number"
  },
  "starsGrowthPercent": {
    "label": "Growth %",
    "format": "number"
  },
  "topics": {
    "label": "Topics",
    "format": "text"
  },
  "license": {
    "label": "License",
    "format": "text"
  },
  "lastUpdated": {
    "label": "Last Updated",
    "format": "text"
  }
}
```

## About this Actor

This example demonstrates how to use [GitHub Trending Scraper](https://apify.com/automation-lab/github-trending-scraper) with a specific input configuration. Visit the [Actor detail page](https://apify.com/automation-lab/github-trending-scraper) to learn more, explore other use cases, and run it yourself.