From e3123252a4c65c88d89650ecef90aef8367e2999 Mon Sep 17 00:00:00 2001
From: modeco80 <lily.modeco80@protonmail.ch>
Date: Fri, 23 Aug 2024 09:58:08 -0400
Subject: [PATCH] release 0.2.4

Please see the release notes for additional information regarding this superqemu release.
---
 RELEASE_NOTES.md | 12 ++++++++++++
 package.json     | 12 +++++++++---
 src/QemuVM.ts    |  3 ++-
 3 files changed, 23 insertions(+), 4 deletions(-)
 create mode 100644 RELEASE_NOTES.md

diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
new file mode 100644
index 0000000..e4e7846
--- /dev/null
+++ b/RELEASE_NOTES.md
@@ -0,0 +1,12 @@
+# Superqemu Release Notes
+
+
+## `v0.2.4`
+
+This release contans breaking changes:
+
+- Superqemu no longer depends on nodejs-rfb, or provides its own VNC client support. Instead, it still sets up VNC in QEMU, and it provides the required information to connect, but allows you the control to connect to the VNC server QEMU has setup yourself.
+
+## `v0.2.3`
+
+- TCP support
\ No newline at end of file
diff --git a/package.json b/package.json
index 556b501..c9312ba 100644
--- a/package.json
+++ b/package.json
@@ -1,13 +1,15 @@
 {
 	"name": "@computernewb/superqemu",
-	"version": "0.2.4-alpha0",
+	"version": "0.2.4",
 	"description": "A simple and easy to use QEMU supervision runtime for Node.js",
 	"exports": "./dist/index.js",
 	"types": "./dist/index.d.ts",
 	"type": "module",
 	"files": [
 		"./dist",
-		"LICENSE"
+		"LICENSE",
+		"README.md",
+		"RELEASE_NOTES.md"
 	],
 	"scripts": {
 		"build": "parcel build src/index.ts --target node --target types"
@@ -34,5 +36,9 @@
 		"pino-pretty": "^11.2.1",
 		"typescript": ">=3.0.0"
 	},
-	"packageManager": "yarn@4.1.1"
+	"packageManager": "yarn@4.4.0",
+	"repository": {
+		"type": "git",
+		"url": "git+https://git.computernewb.com/computernewb/superqemu.git"
+	}
 }
diff --git a/src/QemuVM.ts b/src/QemuVM.ts
index 734f597..5ed9dfd 100644
--- a/src/QemuVM.ts
+++ b/src/QemuVM.ts
@@ -13,6 +13,7 @@ export enum VMState {
 	Stopping
 }
 
+/// VM definition.
 export type QemuVmDefinition = {
 	id: string;
 	command: string;
@@ -22,6 +23,7 @@ export type QemuVmDefinition = {
 	vncPort: number | undefined;
 };
 
+/// Display information.
 export interface QemuVMDisplayInfo {
 	type: 'vnc-uds' | 'vnc-tcp';
 	// 'vnc-uds'
@@ -94,7 +96,6 @@ export class QemuVM extends EventEmitter {
 
 		this.qmpInstance.on('connected', async () => {
 			self.logger.info('QMP ready');
-
 			self.SetState(VMState.Started);
 		});
 	}