Add note about referencing external API file

Closes #12
2016-05-26 15:36:11 +01:00 · 2016-05-26 15:36:11 +01:00 · ca9010b3b4
commit ca9010b3b4
parent 39fff79e11
1 changed files with 1 additions and 0 deletions
--- 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.