Skip to content

Commit

Permalink
feat(cli, readme): add strict configuration presets
Browse files Browse the repository at this point in the history
  • Loading branch information
F-Kublin committed Dec 5, 2024
1 parent 420c3a6 commit 31742b3
Show file tree
Hide file tree
Showing 8 changed files with 1,563 additions and 3 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@ const config: ConfigType = {
};
```

> [!CAUTION]
> The default/strict configuration should not be in any way interpreted as legal advice.
### Default configuration

LAC offers a default configuration for whitelist and blacklist, available by running the configuration wizard or using the `--default-config` flag. The rationale for selecting licenses for each list is available in [this Brainhub article about open source licenses](https://brainhub.eu/library/open-source-licenses-to-avoid). It describes licenses to be wary of as:
Expand All @@ -89,8 +92,9 @@ LAC offers a default configuration for whitelist and blacklist, available by run
> The key in managing licenses is to understand how they work, follow their rules, and ideally use software that helps to track the licenses in your product, so as not to break the law or cause problems to your product through inattention.
> [!CAUTION]
> The default configuration should not be in any way interpreted as legal advice.
### Strict configuration

Strict configuration offers a more restrictive whitelist/blacklist preset. The aim was to cover as many licenses as viable, keeping to the guidelines described in the article above.

## Known issues

Expand Down
6 changes: 5 additions & 1 deletion packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ const config: ConfigType = {
};
```

> **CAUTION: The default/strict configuration should not be in any way interpreted as legal advice.**
### Default configuration

LAC offers a default configuration for whitelist and blacklist, available by running the configuration wizard or using the `--default-config` flag. The rationale for selecting licenses for each list is available in [this Brainhub article about open source licenses](https://brainhub.eu/library/open-source-licenses-to-avoid). It describes licenses to be wary of as:
Expand All @@ -86,7 +88,9 @@ LAC offers a default configuration for whitelist and blacklist, available by run
> The key in managing licenses is to understand how they work, follow their rules, and ideally use software that helps to track the licenses in your product, so as not to break the law or cause problems to your product through inattention.
> **CAUTION: The default configuration should not be in any way interpreted as legal advice.**
### Strict configuration

Strict configuration offers a more restrictive whitelist/blacklist preset. The aim was to cover as many licenses as viable, keeping to the guidelines described in the article above.

## Known issues

Expand Down
Loading

0 comments on commit 31742b3

Please sign in to comment.