From fab36cbe3e36e07d4ee5a5b1b4ec8f81fa107ee9 Mon Sep 17 00:00:00 2001
From: kamil-triscik <65410631+kamil-triscik@users.noreply.github.com>
Date: Mon, 7 Aug 2023 08:27:46 +0200
Subject: [PATCH] Introduce CHANGELOG.md (#5)

---
 CHANGELOG.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 CHANGELOG.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..ebc882b
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,27 @@
+# Changelog
+
+## [1.0.0-alpha] - 2023-05-25
+The first release for the new Braiins OS+ Public API, which introduces the first batch of features.
+
+##### Actions
+With actions from `ActionService`, user can start/stop/restart/pause/resume mining (BOS+). Reboot of the whole miner is supported as well.
+
+##### Configuration
+With `ConfigurationService` methods, user can read current miner configuration and configuration constraints.
+
+##### Cooling
+With `CoolingService`methods, user can read current state of fans or current temperatures, or configure immersion mode.
+
+##### Miner
+With `MinerService` methods, user can read miner HW details, overall miner or hashboards statistics.
+
+##### Pools
+With `PoolService` methods, user can read all currently used pool groups, as well as update a specific pool group.
+
+##### Tuner
+With `TunerService` methods, user can read current tuner state and configure tuner power target.
+
+##### Other
+Overall to use gRPC API, user must be authenticated. For this purpose, `AuthenticationService` with `Login` method is present.
+
+The method in `VersionService` provides information about a particular version of the public Braiins OS+ API.