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

fix: Make updating subsection an optional suggestion, and describe it

Browse Source 
Closes #65
This commit is contained in:
Richard Littauer 2017-11-14 15:13:51 -05:00
parent 8e271642f9
commit d05361bb82
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
spec.md
View File

@ -136,12 +136,12 @@ progressively greater amount of knowledge."
**Subsections:**
- `Dependencies`. Required if there are unusual dependencies or dependencies that must be manually installed.
- `Updating`. Optional.
**Suggestions:**
- Link to prerequisite sites for programming language: [npmjs](https://npmjs.com), [godocs](https://godoc.org), etc.
- Include any system-specific information needed for installation.
- If there is no code in the module - for instance, a document-based module - this section is not required.
- An `Updating` section would be useful for most packages, if there are multiple versions which the user may interface with.
### Usage
**Status:** Required by default, optional for doc modules.