@yodaos-pkg/aix 0.1.0 → 0.2.0

package/README.md

@@ -0,0 +1,50 @@
+# @yodaos-jsar/aix
+
+`@yodaos-jsar/aix` is a library for reading and managing **.aix** (AI eXecutable) packages in the web environment using WASM. The `.aix` format is an extension of the [Open Agent Format (OAF)](https://openagentformat.com/spec.html), designed to package AI agents with rich UI/UX capabilities powered by Ink Mini Programs.
+
+## Library Usage (JS/TS)
+
+You can use this library in your JavaScript or TypeScript project to read `.aix` files.
+
+```typescript
+import { AIX } from '@yodaos-jsar/aix';
+
+// Load the .aix file as a Uint8Array
+const response = await fetch('path/to/your.aix');
+const buffer = await response.arrayBuffer();
+const data = new Uint8Array(buffer);
+
+// Create an AIX instance
+const aix = await AIX.from(data);
+
+// List files
+const files = aix.list();
+console.log('Files in package:', files);
+
+// Get version metadata
+const version = aix.getVersion();
+console.log('Package version:', version);
+
+// Read a specific file
+const appJson = aix.readFile('app.json');
+const content = new TextDecoder().decode(appJson);
+console.log('app.json content:', JSON.parse(content));
+```
+
+## Installation
+
+```bash
+npm install @yodaos-jsar/aix
+```
+
+## Build
+
+To build the WASM and TS code:
+
+```bash
+npm run build
+```
+
+## Core Library
+
+The core Rust logic is provided by the [aix](../aix) package.

package/jsr.json

@@ -1,5 +1,5 @@
 {
   "name": "@yodaos-pkg/aix",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "exports": "./index.js"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yodaos-pkg/aix",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Ink AIX Package Reader",
   "main": "index.js",
   "types": "index.d.ts",