Skip to content

Commit 689de76

Browse files
authored
docs(readme): update the message example (#22)
1 parent e3a5aac commit 689de76

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,14 @@ The path to a license notice text. If license is `null`, the header will be expe
5151

5252
## Outputs
5353

54-
The list of files with header issues.
54+
The list of files with header issues and the suggested format (cf. example below):
55+
```
56+
Your header should look like:
57+
58+
# Copyright (C) <FILE_CREATION_YEAR>, Pyronear.
59+
60+
# This program is licensed under the Apache License 2.0.
61+
```
5562

5663
## Example usages
5764

0 commit comments

Comments
 (0)