README.md in bundler-alive-0.1.6 vs README.md in bundler-alive-0.1.7
- old
+ new
@@ -3,18 +3,18 @@
[![Gem Version](https://badge.fury.io/rb/bundler-alive.svg)](https://badge.fury.io/rb/bundler-alive)
![bundler-alive](https://github.com/kyoshidajp/bundler-alive/actions/workflows/ci.yml/badge.svg)
[![Maintainability](https://api.codeclimate.com/v1/badges/a79d53257bc5e93842f6/maintainability)](https://codeclimate.com/github/kyoshidajp/bundler-alive/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/a79d53257bc5e93842f6/test_coverage)](https://codeclimate.com/github/kyoshidajp/bundler-alive/test_coverage)
-`bunder-alive` checks if gems in a RubyGem's `Gemfile.lock` are active.
+`bundler-alive` checks if gems in a RubyGem's `Gemfile.lock` are active.
-Currently GitHub.com and GitLab.com are supported as a source code repository. If the source code repository is archived, then reports as not alive.
+Currently, GitHub.com and GitLab.com are supported as a source code repository. If the source code repository is archived, then reports as not alive.
## Installation
```
-$ gem install bunlder-alive
+$ gem install bundler-alive
```
## Usage
```
@@ -39,29 +39,32 @@
```
$ bundle-alive -G /path/to/Gemfile.lock
```
-## GitLab Access Token
+## Access Token
-When gems are in GitLab.com repository, you MUST set environment variable `BUNDLER_ALIVE_GITLAB_TOKEN`. See the document [Personal access tokens](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html).
+You MUST set environment variables to access source code repository services.
-## Exceeding rate limit
+| Repository service | ENV variable |
+| ------- |---- |
+| GitHub | [`BUNDLER_ALIVE_GITHUB_TOKEN`](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) |
+| GitLab | [`BUNDLER_ALIVE_GITLAB_TOKEN`](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html) |
-In some cases, the following error may be output.
+## Ignore gems
+You can ignore certain gems.
+
```
-Too many requested! Retry later.
+$ bundle-alive -i journey rubocop-junit-formatter
```
-In this case, setting [GitHub Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) as `BUNDLER_ALIVE_GITHUB_TOKEN` environment variable may alleviate the error.
+## Following redirect on RubyGems.org
-## Ignore gems
+The URL for some gems in RubyGems.org may have changed. You can follow the URL (default: doesn't follow).
-You can ignore certain gems.
-
```
-$ bundle-alive -i journey rubocop-junit-formatter
+$ bundle-alive --follow_redirect
```
## Specifying repository URL
In some cases, some gems cannot find the URL of their source code repositories. For this case, you can specify a mapping between the gem and its URL.