Prepare of release 2.1.2 and lint README.md and CHANGELOG.md

CHANGELOG.md

@@ -1,12 +1,17 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 We refer to [GitHub issues](https://github.com/adr/adr-log/issues) by using `#NUM`.
 
-## [unreleased]
+## [2.1.2] – 2019-10-27
+
+### Fixed
+
+- Updated package versions to fix vulnerabilities
 
 ## [2.1.1] – 2017-12-15
 
@@ -40,39 +45,47 @@ We refer to [GitHub issues](https://github.com/adr/adr-log/issues) by using `#NU
 - Initial support for headers (`---`) in `ADR-*.md` files.
 
 ### Changed
+
 - Updated CLI syntax to be more conform with [markdown-toc](https://github.com/jonschlinkert/markdown-toc).
 
 ### Fixed
+
 - The title of the first main heading is used (and not the second line if it is not empty). [#15](https://github.com/adr/adr-log/issues/15)
 - When `adrlog` appears without closing `adrlogstop`, adr-log does not stop with an error anymore.
 - When `adrlog` does not appear, the log is created nevertheless.
 
 ## [1.1.0] – 2017-10-27
 
 ### Added
+
 - We added a CHANGELOG.md. [#2](https://github.com/adr/adr-log/issues/2)
 
 ### Changed
+
 - We update README.md to reflect changed usage. [#3](https://github.com/adr/adr-log/issues/3)
 
 ### Fixed 
+
 - Fix titles to printed in the correct format as described in [#5](https://github.com/adr/adr-log/issues/5).
 - Fix output of help to use "LOG" instead of "TOC". [#6](https://github.com/adr/adr-log/issues/6)
 - Fix help to output "adr-log" instead of "adr-toc". [#4](https://github.com/adr/adr-log/issues/4)
 
 ### Removed
+
 - Removed `bower.json`. [#8](https://github.com/adr/adr-log/issues/8)
 
 ## [1.0.1] – 2017-10-22
 
 ### Fixed
+
 - Fix parsing of cli arguments. [#1](https://github.com/adr/adr-log/issues/1)
 
 ## [1.0.0] – 2017-10-20
 
 Initial version of adr-log.
 
-[unreleased]: https://github.com/adr/adr-log/compare/adr:2.1.1...master
+[unreleased]: https://github.com/adr/adr-log/compare/adr:2.1.2...master
+[2.1.2]: https://github.com/adr/adr-log/compare/adr:2.1.1...2.1.2
 [2.1.1]: https://github.com/adr/adr-log/compare/adr:2.1.0...2.1.1
 [2.1.0]: https://github.com/adr/adr-log/compare/adr:2.0.0...2.1.0
 [2.0.0]: https://github.com/adr/adr-log/compare/adr:1.1.0...2.0.0

README.md

@@ -28,7 +28,7 @@ $ npm install -g adr-log
 
 ## CLI
 
-```
+```text
 Usage: adr-log [-d <directory>] [-i] <input>
 
   input:  The markdown file to contain the table of contents.
@@ -54,7 +54,6 @@ Usage: adr-log [-d <directory>] [-i] <input>
 Consider a directory consisting of three files (`0000-example-1.md`, `0001-example-2.md`, `0002-example-3.md`).
 Execute following command:
 
-
 ```sh
 $ adr-log -d .
 ```
@@ -92,7 +91,6 @@ Result in following `index.md`:
 <!-- adrlogstop -->
 ```
 
-
 ## Developing
 
 - Run `node cli.js` to execute the CLI.
@@ -102,7 +100,6 @@ Result in following `index.md`:
 - Use [relase-it](https://www.npmjs.com/package/release-it) and [github-release-from-changelog](https://github.com/MoOx/github-release-from-changelog) for release management.
   See also [ADR-0003](docs/adr/0003-use-release-it-and-github-release-from-changelog-as-release-tooling.md).
 
-
 ## Related Tooling
 
 [adr-tools](https://github.com/npryce/adr-tools) is the most prominent related tool.
@@ -114,7 +111,6 @@ The difference to adr-log is
 1. adr-log is available using `npm` and thus more easy to install.
 2. adr-tools does not include the heading of each ADR into the output.
 
-
 ## License
 
 Copyright © 2017 [Tino Stadelmaier](https://github.com/tstadelmaier), [Oliver Kopp](https://github.com/koppor), [Armin Hüneburg](https://github.com/hueneburg), [Tobias Wältken](https://github.com/mee4895).