awtrix-ts 1.2.1 → 1.3.1

package/README.md

@@ -6,6 +6,12 @@ TS wrapper for [Awtrix API](https://blueforcer.github.io/awtrix3/#/api).
 
 The `Awtrix` class provides a TypeScript interface for interacting with the Awtrix device API. It supports device control, settings management, notifications, app switching, indicators, moodlight, and more.
 
+## Installation
+
+```bash
+npm i --save awtrix-ts
+```
+
 ### Usage
 
 ```typescript
@@ -224,6 +230,14 @@ await setTimeout(2000);
 await awtrix.previousApp();
 ```
 
+#### deleteApp(name: string)
+
+Delete a custom app.
+
+```typescript
+await clock.deleteApp('myApp');
+```
+
 #### Progress Bar Example
 
 Display a progress bar using a custom app:
@@ -272,7 +286,3 @@ await clock.notify({
 
 - All API calls are asynchronous and return Promises.
 - The class exposes enums for transitions, indicators, and effects for convenience.
-
-```
-
-```

package/dist/index.d.ts

@@ -79,6 +79,7 @@ declare class Awtrix {
     launchApp(name: string): Promise<void>;
     nextApp(): Promise<void>;
     previousApp(): Promise<void>;
+    deleteApp(name: string): Promise<void>;
     get(endpoint: string): Promise<any>;
     post(endpoint: string, data?: object): Promise<void>;
 }

package/dist/index.js

@@ -133,6 +133,9 @@ class Awtrix {
     async previousApp() {
         await this.post('previousapp');
     }
+    async deleteApp(name) {
+        await this.post(`custom?name=${name}`);
+    }
     async get(endpoint) {
         const response = await fetch(`${this.url}/${endpoint}`);
         const data = await response.json();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "awtrix-ts",
-  "version": "1.2.1",
+  "version": "1.3.1",
   "description": "TypeScript API for Awtrix LED Matrix Display",
   "repository": {
     "type": "git",
@@ -27,5 +27,19 @@
     "eslint": "^9.39.2",
     "eslint-config": "github:7digital/eslint-config",
     "typescript": "^5.9.3"
-  }
+  },
+  "keywords": [
+    "awtrix",
+    "led",
+    "matrix",
+    "api",
+    "typescript",
+    "clock",
+    "ulanzi",
+    "tc001",
+    "smart display",
+    "iot",
+    "pixel-clock",
+    "pixel-display"
+  ]
 }