electrobun 0.0.18 → 0.0.19-beta.6

package/BETA_RELEASE.md

@@ -0,0 +1,67 @@
+# Electrobun Beta Releases
+
+## For Users
+
+### Installing Beta Versions
+
+```bash
+# Install latest beta
+npm install electrobun@beta
+
+# Install specific beta version
+npm install electrobun@0.0.19-beta.1
+
+# View available versions
+npm view electrobun versions --json
+```
+
+### Switching Between Stable and Beta
+
+```bash
+# Switch to stable
+npm install electrobun@latest
+
+# Switch to beta
+npm install electrobun@beta
+```
+
+## For Maintainers
+
+### Publishing Beta Releases
+
+1. **Update version:**
+   ```bash
+   # First beta of a new version
+   npm version 0.0.19-beta.1
+   
+   # Increment beta number
+   bun npm:version:beta
+   ```
+
+2. **Create GitHub Release:**
+   ```bash
+   git push origin v0.0.19-beta.1
+   ```
+   Or manually trigger the workflow with the beta tag.
+
+3. **Publish to npm:**
+   ```bash
+   bun npm:publish:beta
+   ```
+
+### Beta Release Workflow
+
+1. Beta versions use semantic versioning: `MAJOR.MINOR.PATCH-beta.NUMBER`
+2. GitHub Actions automatically marks releases with `-beta` as pre-releases
+3. npm publishes to the `beta` dist-tag (not `latest`)
+4. Users on stable versions won't get beta updates
+
+### Promoting Beta to Stable
+
+```bash
+# Update version to stable
+npm version 0.0.19
+
+# Publish as latest
+bun npm:publish
+```

package/README.md

@@ -8,7 +8,7 @@
 
 ## What is Electrobun?
 
-> Electrobun is in the **_very_** early stages. We currently only support development on arm macs, it has memory leaks, has no tests, it's not available in npm yet, and many core things are still missing.
+> Electrobun is in the **_very_** early stages. We currently support development on macOS, Windows, and Linux, but it has memory leaks, has no tests, and many core things are still missing. We're actively working on stabilizing cross-platform support.
 
 Electrobun aims to be a complete **solution-in-a-box** for building, updating, and shipping ultra fast, tiny, and cross-platform desktop applications written in Typescript.
 Under the hood it uses <a href="https://bun.sh">bun</a> to execute the main process and to bundle webview typescript, and has native bindings written in <a href="https://ziglang.org/">zig</a>.
@@ -29,21 +29,7 @@ Read about how Electrobun is designed, and why, in our <a href="https://www.elec
 
 ## Roadmap
 
-See the detailed <a href="https://github.com/blackboardsh/electrobun/issues/2">detailed Roadmap</a>.
-
-**High level roadmap**
-
-|     | Milestones            | Description                                                                                                                             |
-| :-- | :-------------------- | :-------------------------------------------------------------------------------------------------------------------------------------- |
-| ✅  | Core Architecture     | Ship a working proof of concept with most of the core architecture wired up                                                             |
-| ✅  | Packaging and signing | Packaging and code signing for MacOS                                                                                                    |
-| ✅  | Shipping updates      | Integrated auto-updator                                                                                                                 |
-| ✅  | Webview Tag           | Cross browser electrobun implementation of the <webview> tag that electron has, for isolated nested webviews                            |
-| ✅  | Port co(lab)          | Harden implementation and enough electron parity to migrate <a href="https://colab.sh">https://colab.sh</a> from Electron to Electrobun |
-|     | Custom Web Runtime    | Optionally use a cross-platform web runtime (Chromium) instead of the system's native webview                                           |
-|     | Intel Mac Builds      | build on and distribute to intel macs                                                                                                   |
-|     | API Parity            | Accelerate development of Electrobun apis and native integrations to enable apps to migrate from Electron and Tauri                     |
-|     | Windows support       | build for and distribute to Windows                                                                                                     |
+See the <a href="https://github.com/orgs/blackboardsh/projects/5">roadmap</a>
 
 ## Contributing
 
@@ -53,14 +39,55 @@ As we get closer to 1.0.0 I'll probably make guidelines for PRs and stuff. In th
 
 Ways to get involved at this early stage:
 
-- Follow us on X for updates <a href="https://twitter.com/BlackboardTech">@BlackboardTech</a>
+- Follow us on X for updates <a href="https://twitter.com/BlackboardTech">@BlackboardTech</a> or <a href="https://bsky.app/profile/yoav.codes">@yoav.codes</a>
 - Join the conversation on <a href="https://discord.gg/ueKE4tjaCE">Discord</a>
 - Create and participate in Github issues and discussions
 
-## Building
+## Development Setup
+
+### Prerequisites
+
+**macOS:**
+- Xcode command line tools
+- cmake (install via homebrew: `brew install cmake`)
+
+**Windows:**
+- Visual Studio Build Tools or Visual Studio with C++ development tools
+- cmake
+
+**Linux:**
+- build-essential package
+- cmake
+- webkit2gtk and GTK development packages
+
+### First-time Setup
+
+```bash
+git clone <repo-url>
+cd electrobun
+bun install
+bun dev:playground:clean
+```
+
+### Development Workflow
+
+```bash
+# After making changes to source code
+bun dev:playground
+
+# If you only changed playground code (not electrobun source)
+bun dev:playground:rerun
+
+# If you need a completely fresh start
+bun dev:playground:clean
+```
+
+### Additional Commands
 
-run `bun run install-zig` to install the right version of zig to vendors/zig
+- `bun dev:playground:canary` - Build and run playground in canary mode
+- `bun build:dev` - Build electrobun in development mode
+- `bun build:release` - Build electrobun in release mode
 
-`bun dev:playground` and `bun dev:playground:canary` will compile everything in electrobun in either dev mode and then compile the playground app in either dev or canary modes and run it.
+### Debugging
 
-Note: use `lldb <path-to-bundle>/Contents/MacOS/launcher` and then `run` to debug release builds
+**macOS:** Use `lldb <path-to-bundle>/Contents/MacOS/launcher` and then `run` to debug release builds

package/package.json

@@ -1,17 +1,24 @@
 {
   "name": "electrobun",
-  "version": "0.0.18",
+  "version": "0.0.19-beta.6",
   "description": "Build ultra fast, tiny, and cross-platform desktop apps with Typescript.",
   "license": "MIT",
   "author": "Blackboard Technologies Inc.",
-  "keywords": ["bun", "desktop", "app", "cross-platform", "typescript"],
+  "keywords": [
+    "bun",
+    "desktop",
+    "app",
+    "cross-platform",
+    "typescript"
+  ],
   "exports": {
     ".": "./dist/api/bun/index.ts",
     "./bun": "./dist/api/bun/index.ts",
     "./view": "./dist/api/browser/index.ts"
   },
+  "type": "module",
   "bin": {
-    "electrobun": "dist/electrobun"
+    "electrobun": "./bin/electrobun"
   },
   "homepage": "https://electrobun.dev",
   "repository": {
@@ -19,40 +26,27 @@
     "url": "git+https://github.com/blackboardsh/electrobun.git"
   },
   "scripts": {
+    "postinstall": "mkdir -p bin && bun build src/cli/index.ts --compile --outfile bin/electrobun",
     "start": "bun src/bun/index.ts",
     "check-zig-version": "vendors/zig/zig version",
-    "install-zig": "mkdir -p vendors/zig && curl -L https://ziglang.org/download/0.13.0/zig-macos-aarch64-0.13.0.tar.xz | tar -xJ --strip-components=1 -C vendors/zig zig-macos-aarch64-0.13.0/zig zig-macos-aarch64-0.13.0/lib  zig-macos-aarch64-0.13.0/doc",
-    "build:objc:object": "mkdir -p src/objc/build && clang -c src/objc/objcWrapper.m -o src/objc/build/objcWrapper.o -fobjc-arc -fno-objc-msgsend-selector-stubs",
-    "build:objc:staticlib": "ar rcs src/zig/build/libObjcWrapper.a src/objc/build/objcWrapper.o",
-    "build:objc": "bun build:objc:object && bun build:objc:staticlib",
-    "build:zig": "cd src/zig && ../../vendors/zig/zig build",
-    "build:zig:trdiff": "cd src/bsdiff && ../../vendors/zig/zig build",
-    "build:launcher": "cd src/launcher && ../../vendors/zig/zig build",
-    "build:extractor": "cd src/extractor && ../../vendors/zig/zig build",
-    "build:zig:release": "cd src/zig && ../../vendors/zig/zig build -Doptimize=ReleaseFast",
-    "build:zig:trdiff:release": "cd src/bsdiff && ../../vendors/zig/zig build -Doptimize=ReleaseFast",
-    "build:launcher:release": "cd src/launcher && ../../vendors/zig/zig build -Doptimize=ReleaseSmall",
-    "build:extractor:release": "cd src/extractor && ../../vendors/zig/zig build -Doptimize=ReleaseSmall",
-    "build:cli": "bun build src/cli/index.ts --compile --outfile src/cli/build/electrobun",
-    "build:debug": "npm install && bun build:zig:trdiff && bun build:objc && bun build:zig && bun build:launcher && bun build:extractor && bun build:cli",
-    "build:release": "bun build:objc && bun build:zig:trdiff:release && bun build:zig:release && bun build:launcher:release && bun build:extractor:release && bun build:cli",
-    "build:package": "bun build:release && bun ./scripts/copy-to-dist.ts",
-    "build:dev": "bun build:debug && bun ./scripts/copy-to-dist.ts",
-    "build:electrobun": "bun build:objc && bun build:zig && bun build:bun",
+    "build:dev": "bun build.ts",
+    "build:release": "bun build.ts --release",
     "dev:playground": "bun build:dev && cd playground && npm install && bun build:dev && bun start",
+    "dev:playground:linux": "bun build:dev && npm link && cd playground && npm link electrobun && bun build:dev && bun start",
+    "dev:playground:clean": "cd playground && rm -rf node_modules && npm install && cd .. && bun dev:playground",
     "dev:playground:rerun": "cd playground && bun start",
-    "dev:playground:canary": "bun build:package && cd playground && npm install && bun build:canary && bun start:canary",
+    "dev:playground:canary": "bun build:release && cd playground && npm install && bun build:canary && bun start:canary",
     "dev:docs": "cd documentation && bun start",
     "build:docs:release": "cd documentation && bun run build",
-    "npm:publish": "bun build:package && npm publish"
-  },
-  "devDependencies": {
-    "@types/bun": "1.1.9",
-    "bun": "1.1.29"
+    "npm:publish": "bun build:release && npm publish",
+    "npm:publish:beta": "bun build:release && npm publish --tag beta",
+    "npm:version:beta": "npm version prerelease --preid=beta"
   },
+  "devDependencies": {},
   "dependencies": {
+    "@types/bun": "1.1.9",
     "@oneidentity/zstd-js": "^1.0.3",
-    "rpc-anywhere": "1.5.0",    
+    "rpc-anywhere": "1.5.0",
     "tar": "^6.2.1"
   }
-}
+}