Add link to throttling limits, improve summary text

Author: benschwarz

markdown-templates/inline-pr-comment-with-diff.md

@@ -3,7 +3,7 @@ Images automagically compressed by [Calibre](https://calibreapp.com)'s [image-ac
 Compression reduced images by <strong><%- overallPercentageSaved %>%</strong>, saving <strong><%- overallBytesSaved %></strong>.
 
 <% if(showSummary) { -%>
-**Displaying first 25 images: <%- totalOptimisedCount %> images processed.**
+**Displaying top 25 most improved images. <%- totalOptimisedCount %> images processed.**
 
 <% } -%>
 | Filename | Before | After | Improvement | Visual comparison |
@@ -14,4 +14,4 @@ Compression reduced images by <strong><%- overallPercentageSaved %>%</strong>, s
 
 <% if(unoptimisedImages.length) { -%>
 <%- unoptimisedImages.length %> <%- unoptimisedImages.length > 1 ? 'images' : 'image' %> did not require optimisation.
-<% } %>
+<% } -%>

src/github-commit.ts

@@ -8,6 +8,7 @@ import type { ProcessedImage } from './types/ProcessedImage.d.ts'
 const api = new Octokit()
 
 // Limit to 10 requests/10 seconds
+// See https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api?apiVersion=2022-11-28#about-secondary-rate-limits
 const throttle = pThrottle({
   limit: 10,
   interval: 10000