Move changelog to CHANGELOG.md

vweevers · Jun 1, 2019 · 7e3bb93 · 7e3bb93
1 parent 8b37083
commit 7e3bb93
Show file tree

Hide file tree

Showing 4 changed files with 83 additions and 25 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,66 @@
+# Changelog
+
+_**If you are upgrading:** please see [`UPGRADING.md`](UPGRADING.md)._
+
+## [Unreleased][unreleased]
+
+## [2.1.0] - 2018-11-18
+
+### Changed
+
+- Remove (need for) `os` filter in `package.json`
+- Update `nan` from `~2.10.0` to `~2.11.1`
+- Update `prebuild-install` from `~4.0.0` to `~5.2.1`
+- Update `prebuild` devDependency from `~7.6.0` to `~8.1.2`
+
+### Added
+
+- Add `standard`
+
+## [2.0.0] - 2018-05-19
+
+### Added
+
+- Add prebuilds for Node 8, 9 and 10
+
+### Removed
+
+- Drop Node 4, 5 and 7
+
+## [2.0.0-beta1] - 2016-12-03
+
+### Added
+
+- Add prebuilds for Node 4 - 7
+- Add CLI
+
+### Fixed
+
+- Trim values
+- Ignore empty values and `0.0.0.0` versions
+
+### Removed
+
+- Drop Node &lt; 4 support
+
+## [1.0.1] - 2016-03-27
+
+### Fixed
+
+- Fix installation of prebuilds
+
+## 1.0.0 - 2016-03-27
+
+:seedling: Initial release.
+
+[unreleased]: https://github.com/vweevers/win-version-info/compare/v3.0.0...HEAD
+
+[3.0.0]: https://github.com/vweevers/win-version-info/compare/v2.1.0...v3.0.0
+
+[2.1.0]: https://github.com/vweevers/win-version-info/compare/v2.0.0...v2.1.0
+
+[2.0.0]: https://github.com/vweevers/win-version-info/compare/v2.0.0-beta1...v2.0.0
+
+[2.0.0-beta1]: https://github.com/vweevers/win-version-info/compare/v1.0.1...v2.0.0-beta1
+
+[1.0.1]: https://github.com/vweevers/win-version-info/compare/v1.0.0...v1.0.1
diff --git a/README.md b/README.md
@@ -36,29 +36,6 @@ With [npm](https://npmjs.org) do:
 npm install win-version-info
 ```
 
-## Changelog
-
-### 2.1.0
-
-- Remove (need for) `os` filter in `package.json`
-- Add `standard`
-- Update `nan` from `~2.10.0` to `~2.11.1`
-- Update `prebuild-install` from `~4.0.0` to `~5.2.1`
-- Update `prebuild` devDependency from `~7.6.0` to `~8.1.2`
-
-### 2.0.0
-
-- Drop Node 4, 5 and 7
-- Add prebuilds for Node 8, 9 and 10
-
-### 2.0.0-beta1
-
-- Drop Node < 4 support
-- Trim values
-- Ignore empty values and `0.0.0.0` versions
-- Prebuilds for Node 4 - 7
-- Add CLI
-
 ## License
 
 [MIT](./LICENSE) © 2016-present Vincent Weevers. The main body of this project comes from [ShowVer](http://www.codeproject.com/Articles/2457/ShowVer-exe-command-line-VERSIONINFO-display-progr) © Ted Peck 2002. Converting between UTF-16 and UTF-8 made possible by [UTF8Conversion](https://code.msdn.microsoft.com/C-UTF-8-Conversion-Helpers-22c0a664) ([Apache License 2.0](http://spdx.org/licenses/Apache-2.0.html)) © 2011 Giovanni Dicanio.
diff --git a/UPGRADING.md b/UPGRADING.md
@@ -0,0 +1,11 @@
+# Upgrade Guide
+
+This document describes breaking changes and how to upgrade. For a complete list of changes including minor and patch releases, please refer to the [changelog](CHANGELOG.md).
+
+## v3
+
+Dropped node 6.
+
+## v2
+
+Dropped Node &lt; 6.
diff --git a/package.json b/package.json
@@ -15,10 +15,13 @@
     "skip.js",
     "binding.gyp",
     "src",
-    "deps"
+    "deps",
+    "CHANGELOG.md",
+    "UPGRADING.md"
   ],
   "scripts": {
-    "test": "standard && tape test/*-test.js && prebuild-ci",
+    "test": "standard && hallmark && tape test/*-test.js && prebuild-ci",
+    "hallmark": "hallmark --fix",
     "install": "node skip.js || prebuild-install || node-gyp rebuild",
     "rebuild": "prebuild --compile"
   },
@@ -28,6 +31,7 @@
     "prebuild-install": "~5.3.0"
   },
   "devDependencies": {
+    "hallmark": "^0.1.0",
     "prebuild": "^8.2.1",
     "prebuild-ci": "^3.0.0",
     "standard": "^12.0.1",