release 0.2.4

Please see the release notes for additional information regarding this superqemu release.

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

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"
+	}
 }

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);
 		});
 	}