saturneric/standard-readme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add note about referencing external API file

Browse Source 
Closes #12
This commit is contained in:
Richard Littauer 2016-05-26 15:36:11 +01:00
parent 39fff79e11
commit ca9010b3b4
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -208,6 +208,7 @@ Subsections:
- Describe signatures, return types, callbacks, and events. - Describe signatures, return types, callbacks, and events.
- Cover types covered where not obvious. - Cover types covered where not obvious.
- Describe caveats. - 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 #### Contribute
**Status**: Required. **Status**: Required.