From 5ee173102e04769da9285a3093b0afc6d25c606a Mon Sep 17 00:00:00 2001 From: Niklas Lindgren Date: Thu, 21 Feb 2019 14:45:30 +0000 Subject: [PATCH 1/2] fix: than should be then --- spec.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec.md b/spec.md index 8b5c2cc..9fa5837 100644 --- a/spec.md +++ b/spec.md @@ -6,7 +6,7 @@ A compliant README must satisfy all the requirements listed below. **Requirements:** - Be called README.md (with capitalization). - - If the project supports i18n, the file must be named accordingly: `README.de.md`, where `de` is the BCP 47 Language tag. For naming, prioritize non-regional subtags for languages. If there is only one README and the language is not English, than a different language in the text is permissible without needing to to specify the BCP tag: e.g., `README.md` can be in German if there is no `README.md` in another language. Where there are multiple languages, `README.md` is reserved for English. + - If the project supports i18n, the file must be named accordingly: `README.de.md`, where `de` is the BCP 47 Language tag. For naming, prioritize non-regional subtags for languages. If there is only one README and the language is not English, then a different language in the text is permissible without needing to to specify the BCP tag: e.g., `README.md` can be in German if there is no `README.md` in another language. Where there are multiple languages, `README.md` is reserved for English. - Be a valid Markdown file. - Sections must appear in order given below. Optional sections may be omitted. - Sections must have the titles listed below, unless otherwise specified. If the README is in another language, the titles must be translated into that language. From 845a854a23a859e6f30270856cc8fdcd8b0349e4 Mon Sep 17 00:00:00 2001 From: Niklas Lindgren Date: Thu, 21 Feb 2019 14:46:56 +0000 Subject: [PATCH 2/2] fix: use ascii apostrophy --- spec.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec.md b/spec.md index 9fa5837..5311418 100644 --- a/spec.md +++ b/spec.md @@ -2,7 +2,7 @@ A compliant README must satisfy all the requirements listed below. -> Note: Standard Readme is designed for open source libraries. Although it’s [historically](README.md#background) made for Node and npm projects, it also applies to libraries in other languages and package managers. +> Note: Standard Readme is designed for open source libraries. Although it's [historically](README.md#background) made for Node and npm projects, it also applies to libraries in other languages and package managers. **Requirements:** - Be called README.md (with capitalization).