Add API request throttling to find-inactive-members script to respect API rate limit headers

api/ruby/find-inactive-members/README.md

@@ -7,6 +7,7 @@ find_inactive_members.rb - Find and output inactive members in an organization
     -e, --email                      Fetch the user email (can make the script take longer)
     -o, --organization MANDATORY     Organization to scan for inactive users
     -v, --verbose                    More output to STDERR
+    -t, --no-throttle                Disable API request throttling (use with caution)
     -h, --help                       Display this help
 ```
 
@@ -24,15 +25,17 @@ cd platform-samples/api/ruby/find-inactive-members
 ### Install dependencies
 
 ```shell
-gem install octokit
+gem install octokit faraday
 ```
 
 ### Configure Octokit
 
 The `OCTOKIT_ACCESS_TOKEN` is required in order to see activities on private repositories. Also note that GitHub.com has an rate limit of 60 unauthenticated requests per hour, which this tool can easily exceed. Access tokens can be generated at https://github.com/settings/tokens. The `OCTOKIT_API_ENDPOINT` isn't required if connecting to GitHub.com, but is required if connecting to a GitHub Enterprise instance.
 
+`OCTOKIT_ACCESS_TOKEN` needs the scopes `read:org`, `read:user`, `repo`, and `user:email`.
+
 ```shell
-export OCTOKIT_ACCESS_TOKEN=00000000000000000000000     # Required if looking for activity in private repositories.
+export OCTOKIT_ACCESS_TOKEN=00000000000000000000000     # Required if looking for activity in private repositories. 
 export OCTOKIT_API_ENDPOINT="https://<your_github_enterprise_instance>/api/v3" # Not required if connecting to GitHub.com.
 ```
 
@@ -54,3 +57,17 @@ Members are defined as inactive if they **have not performed** any of the follow
 - Merged or pushed commits into the default branch
 - Opened an Issue or Pull Request
 - Commented on an Issue or Pull Request
+
+## Rate Limit
+
+The script will use the following rate limit headers returned by the API to throttle requests in order to stay within the rate limit.  You can disable throttling using the `-t` option.
+
+| Header name | Description |
+| --- | --- |
+| `x-ratelimit-limit` | The maximum number of requests that you can make per hour |
+| `x-ratelimit-remaining` | The number of requests remaining in the current rate limit window |
+| `x-ratelimit-used` | The number of requests you have made in the current rate limit window |
+| `x-ratelimit-reset` | The time at which the current rate limit window resets, in UTC epoch seconds |
+| `x-ratelimit-resource` | The rate limit resource that the request counted against. |
+
+For more information about the different resources, see [REST API endpoints for rate limits](https://docs.github.com/en/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user).