Skip to content

Commit 7e7944e

Browse files
authored
Merge pull request #439 from github/using-LICENSE
Update docs: `using:` field value should be a link to LICENSE implementation
2 parents c2d70ff + 582d202 commit 7e7944e

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Licenses sit in the `/_licenses` folder. Each license has YAML front matter desc
5454
* `hidden` - Whether the license is hidden from the license list (defaults to true)
5555
* `nickname` - Customary short name if applicable (e.g, GPLv3)
5656
* `note` - Additional information about the licenses
57-
* `using` - A list of notable projects using the license in the form of `project_name: "url"`
57+
* `using` - A list of up to 3 notable projects using the license with straightforward LICENSE files which serve as examples newcomers can follow and that can be detected by [licensee](https://github.com/benbalter/licensee) in the form of `project_name: license_file_url`
5858
* `redirect_from` - Relative path(s) to redirect to the license from, to prevent breaking old URLs
5959

6060
### Auto-populated fields

_data/meta.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
required: false
5353

5454
- name: using
55-
description: 'A list of notable projects using the license in the form of `project_name: "url"`'
55+
description: 'A list of up to 3 notable projects using the license with straightforward LICENSE files which serve as examples newcomers can follow and that can be detected by [licensee](https://github.com/benbalter/licensee) in the form of `project_name: license_file_url`'
5656
required: false
5757

5858
- name: redirect_from

0 commit comments

Comments
 (0)