Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove line breaks in README #18

Merged
merged 1 commit into from
May 2, 2018
Merged

Remove line breaks in README #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 5 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,15 @@ go-license

Usage
-----
Run `./go-license --config=license.yml [files]` to apply the license specified by the configuration in `license.yml` to
all of the specified files (only the files that end in `.go` and are not excluded by configuration are processed).
Run `./go-license --config=license.yml [files]` to apply the license specified by the configuration in `license.yml` to all of the specified files (only the files that end in `.go` and are not excluded by configuration are processed).

Run `./go-license --config=license.yml --remove [files]` to remove the license specified by the configuration in
`license.yml` from all of the specified files (only the files that end in `.go` and are not excluded by configuration
are processed).
Run `./go-license --config=license.yml --remove [files]` to remove the license specified by the configuration in `license.yml` from all of the specified files (only the files that end in `.go` and are not excluded by configuration are processed).

Run `./go-license --config=license.yml --verify [files]` to verify that the license specified by the configuration is
applied to all of the specified files `*.go` files (only the files that end in `.go` and are not excluded by
configuration are processed). If the license is not applied properly to any of the files, the files that do not match
are printed and the program exits with a non-0 exit code.
Run `./go-license --config=license.yml --verify [files]` to verify that the license specified by the configuration is applied to all of the specified files `*.go` files (only the files that end in `.go` and are not excluded by configuration are processed). If the license is not applied properly to any of the files, the files that do not match are printed and the program exits with a non-0 exit code.

Configuration
-------------
The configuration file specifies the header that should be applied as a `header` key. It also supports an `exclude`
parameter that specifies files or paths that should be excluded from configuration.
The configuration file specifies the header that should be applied as a `header` key. It also supports an `exclude` parameter that specifies files or paths that should be excluded from configuration.

Here is an example configuration file:

Expand Down Expand Up @@ -52,7 +45,6 @@ exclude:
- "vendor"
```

The string `{{YEAR}}` indicates that, when a license is added by the tool, the current year will be used. For operations
that match licenses (for verification or removal), `{{YEAR}}` will match any 4-digit number.
The string `{{YEAR}}` indicates that, when a license is added by the tool, the current year will be used. For operations that match licenses (for verification or removal), `{{YEAR}}` will match any 4-digit number.

The `custom-headers` configuration allows custom headers to be specified for matching names or paths.