Merge pull request #18 from atc0005/add-changelog-file

Add CHANGELOG file for v0.1.0 release

CHANGELOG.md

@@ -0,0 +1,63 @@
+# Changelog
+
+## Overview
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a
+Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+Please [open an issue](https://github.com/atc0005/go-lockss/issues) for any
+deviations that you spot; I'm still learning!.
+
+## Types of changes
+
+The following types of changes will be recorded in this file:
+
+- `Added` for new features.
+- `Changed` for changes in existing functionality.
+- `Deprecated` for soon-to-be removed features.
+- `Removed` for now removed features.
+- `Fixed` for any bug fixes.
+- `Security` in case of vulnerabilities.
+
+## [Unreleased]
+
+- placeholder
+
+## [v0.1.0] - 2020-08-16
+
+### Added
+
+Planned features:
+
+- `n2n` binary (or of another name) to serve as a Nagios plugin for regular
+  monitoring of node-to-node communication (voting, polling, repairs)
+
+Features of the initial prototype:
+
+- `hayoh` binary
+  - User configurable logging levels
+  - User configurable logging format
+  - User configurable timeouts (config file retrieval, port connection tests)
+  - User configurable location of LOCKSS configuration/property settings
+    (custom file or URL)
+  - User configurable *additional* TCP ports to check
+    - the default is to scan the LCAP port provided in the LOCKSS
+      configuration/property XML file
+
+Worth noting (in no particular order):
+
+- Command-line flags support via `flag` standard library package
+- Go modules (vs classic `GOPATH` setup)
+- GitHub Actions Workflows which apply linting and build checks
+- Makefile for general use cases (including local linting)
+  - Note: See README for available options if building on Windows
+- Dependabot updates monitoring
+- Vendored dependencies
+- README
+  - Link badges to applicable GitHub Actions workflows results
+
+[Unreleased]: https://github.com/atc0005/go-lockss/compare/v0.1.0...HEAD
+[v0.1.0]: https://github.com/atc0005/go-lockss/releases/tag/v0.1.0