docs: Update readme and examples for updated go-github-ratelimit and introduce go-github-pagination

[gofri]

Closes: #2618.

Hey,

Opened this PR following the v2 release of go-github-ratelimit (🥳) that supports primary rate limits handling,
as well as the releaes of go-github-pagination as mentioned in #2618.

This PR only touches the main README file and the examples.

[gmlewis]

Thank you, @gofri!

[gmlewis]

These changes will have to wait until be bump the Go toolchain for the entire repo.

[gmlewis]

OK, please delete lines 4 and 5 and merge in the latest changes from the master branch which should make line 3 say go 1.23.0 and then we should be good to go.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 14 lines in your changes missing coverage. Please review.

Project coverage is 91.25%. Comparing base (259cd22) to head (91b0abd).
Report is 3 commits behind head on master.

Files with missing lines	Patch %	Lines
example/ratelimit/main.go	0.00%	14 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3504      +/-   ##
==========================================
+ Coverage   91.21%   91.25%   +0.03%     
==========================================
  Files         182      183       +1     
  Lines       15930    16058     +128     
==========================================
+ Hits        14531    14654     +123     
- Misses       1225     1230       +5     
  Partials      174      174              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[gofri]

@gmlewis
Sounds great! Thanks!
I'll try to monitor this repo and ping here when it's relevant (just in case)

[gmlewis]

Doesn't this work with go 1.23.0 ?
We would prefer to use that due to #3423 (comment)

[gofri]

no problem at all, fixed.
I just misunderstood your previous comment to mean that you want line 3 to remain.

[gmlewis]

go: github.com/gofri/go-github-ratelimit/[email protected] requires go >= 1.23.1 (running go 1.23.0; GOTOOLCHAIN=go1.22.0+auto; go.mod sets go 1.23.0)

Is there any way that your package could change its requirements to 1.23.0 ?

[gmlewis]

There's a long thread in #3423 that describes why this is beneficial.

[gofri]

go: github.com/gofri/go-github-ratelimit/[email protected] requires go >= 1.23.1 (running go 1.23.0; GOTOOLCHAIN=go1.22.0+auto; go.mod sets go 1.23.0)

Is there any way that your package could change its requirements to 1.23.0 ?

Sure, I don't mind at all. I'll push a new tag and update this branch accordingly.

There's a long thread in #3423 that describes why this is beneficial.

huh thanks for sharing that info.

[gofri]

@gmlewis done! let me know if you need me to fix anything else.

[gmlewis]

@gmlewis done! let me know if you need me to fix anything else.

It looks like the linter is requiring go mod tidy to run in the examples directory.
I think if you run ./script/generate.sh then it will run go mod tidy for you with the correct GOTOOLCHAIN env var setting.

[gofri]

@gmlewis
done! thank you for your patience with this.

[gmlewis]

In the future, please don't force push PRs in this repo as it blows away previous review history.

[gmlewis]

Thank you, @gofri!
LGTM.

Awaiting second LGTM+Approval from any other contributor to this repo before merging.

@stevehipwell - might you have time for a code review? Thank you!

[stevehipwell]

LGTM

[gmlewis]

Thank you, @stevehipwell!
Merging.