From ca9010b3b489c35e29bff7f4cce3db31ea7891cd Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Thu, 26 May 2016 15:36:11 +0100 Subject: [PATCH] Add note about referencing external API file Closes #12 --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index b96f7b6..f084d6b 100644 --- a/README.md +++ b/README.md @@ -208,6 +208,7 @@ Subsections: - Describe signatures, return types, callbacks, and events. - Cover types covered where not obvious. - Describe caveats. +- If using an external API generator (like go-doc, js-doc, or so on), point to an external `API.md` file. This can be the only item in the section, if present. #### Contribute **Status**: Required.