[Bug]: slim-leaderboard docs do not explain PAT

[mrmuszynski]

Checked for duplicates

Yes - I've already checked

Describe the bug

When attempting to test the slim-leaderboard cli, I was prompted to get a PAT. But when I went to get a PAT, I was a bit overwhelmed by not understanding exactly what I need to give access to. I don't want to be overly liberal when making the PAT, but I don't understand easily what slim-leaderboard needs.

What did you expect?

I expected to be able to run slim-leaderboard on local code, but taking a look at the cli code, it seems that's not how it was designed. Short of being able to run it completely locally, I would expect to have instructions on which access it needs in order to work

Reproducible steps

1. run slim-leaderboard without having GITHUB_TOKEN set

What is your environment?

I don't think this matters for this simple of a ticket. But let me know if I'm wrong.

[yunks128]

@mrmuszynski Thanks for the valuable feedback! Yes, the tool is designed to work directly with remote GitHub repositories. Our goal was to make automation easier through GitHub Actions and enable automatic dashboard updates across multiple repositories for low maintenance and continuous status monitoring. I agree that we should clearly describe the required PAT scope, and I’ll also add support for local scanning options. Thanks again!