From 42f1df924196abf9a110e5b6e8eb96fa9fbf6cd4 Mon Sep 17 00:00:00 2001 From: Titus Wormer Date: Tue, 14 Nov 2017 19:11:31 -0500 Subject: [PATCH] Add mention of relation to Node and npm Closes GH-64. --- README.md | 2 ++ spec.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/README.md b/README.md index b337317..fa7cfd9 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,8 @@ This repository contains: 4. [A badge](#badge) to point to this spec. 5. [Examples of standard READMEs](example-readmes/) - such as this file you are reading. +Standard Readme is designed for open source libraries. Although it’s [historically](#background) made for Node and npm projects, it also applies to libraries in other languages and package managers. + ## Table of Contents diff --git a/spec.md b/spec.md index 56ca52a..e736c85 100644 --- a/spec.md +++ b/spec.md @@ -2,6 +2,8 @@ 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. + **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.