Add README section on 'yanked' releases.

olivierlacan · Dec 13, 2014 · 0417b6b · 0417b6b
1 parent 82d507f
commit 0417b6b
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 ## [Unreleased][head]
 - No significant changes.
 
+## [0.0.6][v0.0.6] - 2014-12-12
+### Added
+- README section on "yanked" releases.
+
 ## [0.0.5][v0.0.5] - 2014-08-09
 ### Added
 - Markdown links to version tags on release headings

diff --git a/README.md b/README.md
@@ -111,6 +111,19 @@ or contribute to it, much like [open source project badges](http://shields.io).
 When I refer to a "change log", I'm talking about the function of this
 file: to log changes.
 
+## What about yanked releases?
+Yanked releases are versions that had to be pulled because of a serious
+bug or security issue. Often these versions don't even appear in change
+logs. They should. This is how you should display them:
+
+```
+## 0.0.5 - 2014-12-13 [YANKED]
+```
+
+The `[YANKED]` tag is loud for a reason. It's important for people to
+notice it. Since it's surrounded by brackets it's also easier to parse
+programmatically.
+
 ### How can I contribute?
 This document is not the **truth**; it’s my carefully considered
 opinion, along with information and examples I gathered.