v2.5.1 (With NPM)

AlbertShown · AlbertShown · commit 1a445692ae27 · 2025-02-11T18:55:32.000-05:00
diff --git a/README.md b/README.md
@@ -2,9 +2,7 @@
 
 ![Logo](https://raw.githubusercontent.com/webui-dev/webui-logo/main/webui_bun.png)
 
-# NOT USABLE YET - UNDERDEVELOPMENT
-
-# Bun-WebUI v2.5.0 (Beta)
+# Bun-WebUI v2.5.1 (Beta)
 
 [last-commit]: https://img.shields.io/github/last-commit/webui-dev/webui?style=for-the-badge&logo=github&logoColor=C0CAF5&labelColor=414868
 [release-version]: https://img.shields.io/github/v/tag/webui-dev/webui?style=for-the-badge&logo=webtrees&logoColor=C0CAF5&labelColor=414868&color=7664C6
@@ -40,16 +38,22 @@ is written in Bun using WebUI as the GUI library.
 
 ![ScreenShot](img/webui_bun_example.png)
 
-## Installation
+## NPM Installation
+
+```sh
+npm install @webui-dev/bun-webui
+```
 
-Specific version: `import { WebUI } from "webui";`
+## Import Package
 
-Latest version: `import { WebUI } from "https://bun.sh/x/webui/mod.ts";`
+```js
+import { WebUI } from '@webui-dev/bun-webui';
+```
 
 ## Minimal Example
 
 ```js
-import { WebUI } from "webui";
+import { WebUI } from '@webui-dev/bun-webui';
 
 const myWindow = new WebUI();
 myWindow.show('<html><script src="webui.js"></script> Hello World! </html>');
diff --git a/examples/custom_file_handler/custom_file_handler.ts b/examples/custom_file_handler/custom_file_handler.ts
@@ -2,10 +2,10 @@
 // bun run custom_file_handler.ts
 
 // To import from local (Debugging and Development)
-import { WebUI } from "../../mod.ts";
+// import { WebUI } from "../../mod.ts";
 
-// To import from online `https://bun.sh` (Production)
-// import { WebUI } from "webui";
+// To import from NPM (Production)
+import { WebUI } from '@webui-dev/bun-webui';
 
 // Return HTTP header + file raw binary content
 const getFile = async (contentType: string, filename: string): Promise<Uint8Array> => {
diff --git a/examples/custom_web_server/custom_web_server.ts b/examples/custom_web_server/custom_web_server.ts
@@ -3,10 +3,10 @@
 // bun run custom_web_server.ts
 
 // To import from local (Debugging and Development)
-import { WebUI } from "../../mod.ts";
+// import { WebUI } from "../../mod.ts";
 
-// To import from online `https://bun.sh` (Production)
-// import { WebUI } from "webui";
+// To import from NPM (Production)
+import { WebUI } from '@webui-dev/bun-webui';
 
 async function allEvents(e: WebUI.Event) {
   /*
diff --git a/examples/hello_world/hello_world.ts b/examples/hello_world/hello_world.ts
@@ -2,10 +2,10 @@
 // bun run hello_world.ts
 
 // To import from local (Debugging and Development)
-import { WebUI } from "../../mod.ts";
+// import { WebUI } from "../../mod.ts";
 
-// To import from online `https://bun.sh` (Production)
-// import { WebUI } from "webui";
+// To import from NPM (Production)
+import { WebUI } from '@webui-dev/bun-webui';
 
 const myHtml = `<!DOCTYPE html>
 <html>
diff --git a/examples/send_raw_binary/send_raw_binary.ts b/examples/send_raw_binary/send_raw_binary.ts
@@ -2,10 +2,10 @@
 // bun run send_raw_binary.ts
 
 // To import from local (Debugging and Development)
-import { WebUI } from "../../mod.ts";
+// import { WebUI } from "../../mod.ts";
 
-// To import from online `https://bun.sh` (Production)
-// import { WebUI } from "webui";
+// To import from NPM (Production)
+import { WebUI } from '@webui-dev/bun-webui';
 
 const myHtml = `<!DOCTYPE html>
 <html>
diff --git a/mod.ts b/mod.ts
@@ -16,7 +16,7 @@
  * ## Minimal Example
  *
  * ```ts
- * import { WebUI } from "webui";
+ * import { WebUI } from '@webui-dev/bun-webui';
  *
  * const myWindow = new WebUI();
  * myWindow.show("<html><script src=\"webui.js\"></script> Hello World! </html>");
diff --git a/package.json b/package.json
@@ -0,0 +1,15 @@
+{
+  "name": "@webui-dev/bun-webui",
+  "version": "2.5.1",
+  "description": "Use any web browser as GUI, with Bun in the backend and HTML5 in the frontend.",
+  "main": "mod.ts",
+  "directories": {
+    "example": "examples"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 0"
+  },
+  "keywords": ["gui", "ui", "webui", "browser", "webview"],
+  "author": "Hassan Draga",
+  "license": "MIT"
+}
diff --git a/src/ffi_worker.ts b/src/ffi_worker.ts
@@ -1,5 +1,5 @@
 /*
-  WebUI Bun 2.5.0
+  WebUI Bun 2.5.1
   http://webui.me
   https://github.com/webui-dev/bun-webui
   Copyright (c) 2020-2025 Hassan Draga.
diff --git a/src/webui.ts b/src/webui.ts
@@ -1,5 +1,5 @@
 /*
-  WebUI Bun 2.5.0
+  WebUI Bun 2.5.1
   http://webui.me
   https://github.com/webui-dev/bun-webui
   Copyright (c) 2020-2025 Hassan Draga.
@@ -754,7 +754,7 @@ export class WebUI {
   }
 
   static get version() {
-    return "2.5.0";
+    return "2.5.1";
   }
 }
 

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`* ## Minimal Example`
`17`	`17`	`*`
`18`	`18`	* ```ts
`19`		`- * import { WebUI } from "webui";`
	`19`	`+ * import { WebUI } from '@webui-dev/bun-webui';`
`20`	`20`	`*`
`21`	`21`	`* const myWindow = new WebUI();`
`22`	`22`	`* myWindow.show("<html><script src=\"webui.js\"></script> Hello World! </html>");`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- WebUI Bun 2.5.0`
	`2`	`+ WebUI Bun 2.5.1`
`3`	`3`	`http://webui.me`
`4`	`4`	`https://github.com/webui-dev/bun-webui`
`5`	`5`	`Copyright (c) 2020-2025 Hassan Draga.`
`@@ -754,7 +754,7 @@ export class WebUI {`
`754`	`754`	`}`
`755`	`755`
`756`	`756`	`static get version() {`
`757`		`- return "2.5.0";`
	`757`	`+ return "2.5.1";`
`758`	`758`	`}`
`759`	`759`	`}`
`760`	`760`