README.md in license_finder-5.11.1 vs README.md in license_finder-6.0.0
- old
+ new
@@ -2,21 +2,21 @@
[](https://codeclimate.com/github/pivotal/LicenseFinder)
Build status
* Ruby 2.3.8 [](https://norsk.cf-app.com/teams/main/pipelines/LicenseFinder)
-* Ruby 2.4.5 [](https://norsk.cf-app.com/teams/main/pipelines/LicenseFinder)
-* Ruby 2.5.3 [](https://norsk.cf-app.com/teams/main/pipelines/LicenseFinder)
+* Ruby 2.4.9 [](https://norsk.cf-app.com/teams/main/pipelines/LicenseFinder)
+* Ruby 2.5.7 [](https://norsk.cf-app.com/teams/main/pipelines/LicenseFinder)
* Ruby 2.6.5 [](https://norsk.cf-app.com/teams/main/pipelines/LicenseFinder)
-* JRuby 9.1.17.0 [](https://norsk.cf-app.com/teams/main/pipelines/LicenseFinder)
-* JRuby 9.2.6.0 [](https://norsk.cf-app.com/teams/main/pipelines/LicenseFinder)
+* Ruby 2.7.0 [](https://norsk.cf-app.com/teams/main/pipelines/LicenseFinder)
+* JRuby 9.2.9.0 [](https://norsk.cf-app.com/teams/main/pipelines/LicenseFinder)
LicenseFinder works with your package managers to find dependencies,
detect the licenses of the packages in them, compare those licenses
-against a user-defined whitelist, and give you an actionable exception
-report.
+against a user-defined list of permitted licenses,
+and give you an actionable exception report.
* code: https://github.com/pivotal/LicenseFinder
* ci: https://norsk.cf-app.com/teams/main/pipelines/LicenseFinder
* docker: [licensefinder/license_finder](https://hub.docker.com/r/licensefinder/license_finder/)
* the docker image contains all the package managers needed to run `license_finder`
@@ -234,25 +234,25 @@
```sh
$ license_finder approvals add awesome_gpl_gem --who CTO --why "Go ahead"
```
-### Whitelisting
+### Permitting Licenses
Approving packages one-by-one can be tedious. Usually your business has
blanket policies about which packages are approved. To tell `license_finder`
that any package with the MIT license should be approved, run:
``` sh
-$ license_finder whitelist add MIT
+$ license_finder permitted_licenses add MIT
```
Any current or future packages with the MIT license will be excluded from the
output of `license_finder`.
-You can also record `--who` and `--why` when changing the whitelist, or making
-any other decision about your project.
+You can also record `--who` and `--why` when changing permitted licenses,
+or making any other decision about your project.
## Output and Artifacts
### Decisions file
@@ -268,11 +268,11 @@
### Output from `action_items`
You could expect `license_finder`, which is an alias for `license_finder
action_items` to output something like the following on a Rails project where
-MIT had been whitelisted:
+MIT had been permitted:
```
Dependencies that need approval:
highline, 1.6.14, ruby
@@ -368,17 +368,17 @@
dependencies to this list. A likely item to exclude is `bundler`,
since it is a common dependency whose version changes from machine to
machine. Adding it to the `ignored_dependencies` would prevent it
(and its oscillating versions) from appearing in reports.
-### Blacklisting Licenses
+### Restricting Licenses
-Some projects will have a list of licenses that cannot be used. You can add
-these licenses to the blacklist `license_finder blacklist add`. Any dependency
-that has exclusively blacklisted licenses will always appear in the action
-items, even if someone attempts to manually approve or whitelist it. However,
-if a dependency has even one license outside of the blacklist, it can still be
-manually approved or whitelisted.
+Some projects will have a list of licenses that cannot be used. You can
+restrict these licenses with `license_finder restricted_licenses add`. Any dependency
+that has exclusively restricted licenses will always appear in the action
+items, even if someone attempts to manually approve or permit it. However,
+if a dependency has even one license that is not restricted, it can still be
+manually approved or permitted.
## Configuration
Be default, `license_finder` expects the decisions file to be stored at