From 675309ad24026a5766fe6fdb1e1ec4dd590279f3 Mon Sep 17 00:00:00 2001 From: Mike Linksvayer <mlinksva@github.com> Date: Thu, 30 Jun 2016 09:47:28 -0700 Subject: [PATCH] make explicit in docs what I was about to leave as pull request desc --- README.md | 2 +- _data/meta.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 01726a6..6abcf54 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ Licenses sit in the `/_licenses` folder. Each license has YAML front matter desc * `hidden` - Whether the license is hidden from the license list (defaults to true) * `nickname` - Customary short name if applicable (e.g, GPLv3) * `note` - Additional information about the licenses -* `using` - A list of up to 3 notable projects using the license and a link to each of their LICENSE files in the form of `project_name: "url"` +* `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"` * `redirect_from` - Relative path(s) to redirect to the license from, to prevent breaking old URLs ### Auto-populated fields diff --git a/_data/meta.yml b/_data/meta.yml index a218c77..112cd16 100644 --- a/_data/meta.yml +++ b/_data/meta.yml @@ -52,7 +52,7 @@ required: false - name: using - description: 'A list of up to 3 notable projects using the license and a link to each of their LICENSE files in the form of `project_name: "url"`' + 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"`' required: false - name: redirect_from