Merge pull request #14 from atc0005/i8-add-changelog

Add CHANGELOG for v0.1.0 release

CHANGELOG.md

@@ -0,0 +1,74 @@
+# 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/check-path/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-11-02
+
+### Added
+
+Initial release!
+
+This release provides an early version of a Nagios plugin used to monitor
+attributes of one or many specified paths. The intention is to provide a
+multi-purpose or "Swiss Army Knife" tool that is capable of monitoring many
+different attributes, though flexible enough to easily monitor just one.
+
+- Statically linked binary release
+  - Built using Go 1.15.3
+  - Windows
+    - x86
+    - x64
+  - Linux
+    - x86
+    - x64
+
+#### Available now
+
+Currently, monitored attributes include:
+
+- `age`
+  - `CRITICAL` and `WARNING` thresholds
+- `size`
+  - `CRITICAL` and `WARNING` thresholds
+- `username`
+  - `CRITICAL` or `WARNING` (as specified) if missing
+  - **NOTE**: this check is not supported on Windows
+- `group name`
+  - `CRITICAL` or `WARNING` (as specified) if missing
+  - **NOTE**: this check is not supported on Windows
+- `exists`
+  - `CRITICAL` or `WARNING` (as specified) if present
+
+Optional support for ignoring missing files (does not apply to the `exists`
+checks) and recursive evaluation is available, but disabled by default.
+
+#### Coming "Soon"
+
+- Permissions checks
+
+[Unreleased]: https://github.com/atc0005/check-path/compare/v0.1.0...HEAD
+[v0.1.0]: https://github.com/atc0005/check-path/releases/tag/v0.1.0