skapi-js 1.2.13-beta.0 → 1.2.14-beta.1

package/README.md

@@ -1,5 +1,14 @@
 # Skapi
 
+[![Package Compatibility](https://github.com/broadwayinc/skapi-js/actions/workflows/compatibility.yml/badge.svg)](https://github.com/broadwayinc/skapi-js/actions/workflows/compatibility.yml)
+[![npm version](https://img.shields.io/npm/v/skapi-js.svg)](https://www.npmjs.com/package/skapi-js)
+![Node](https://img.shields.io/badge/node-18%20%7C%2020%20%7C%2022-339933)
+![Module](https://img.shields.io/badge/module-CJS%20%7C%20ESM-blue)
+![Browser](https://img.shields.io/badge/browser-UMD%20bundle-orange)
+![TypeScript](https://img.shields.io/badge/types-TypeScript-3178C6)
+
+**Tested environments:** Node 18/20/22, CommonJS, ESM, TypeScript consumers, Browser UMD bundle.
+
 ### Zero-Setup Serverless Backend
 
 Skapi is a backend API that runs entirely serverless—no complex installations, no server configurations, and no database management required. Build full-featured web applications faster and focus on what matters: your product.
@@ -71,6 +80,16 @@ const skapi = new Skapi('SERVICE_ID');
 export { skapi }
 ```
 
+### TypeScript (React, Vue, etc.)
+
+```typescript
+import { Skapi } from 'skapi-js';
+import type { RecordData, DatabaseResponse } from 'skapi-js';
+
+const skapi = new Skapi('SERVICE_ID');
+let databaseRecords: DatabaseResponse<RecordData>;
+```
+
 ### Node.js (CommonJS)
 
 To use Skapi in NodeJS, import the library as shown below:
@@ -80,6 +99,13 @@ const { Skapi } = require('skapi-js');
 const skapi = new Skapi('SERVICE_ID');
 ```
 
+### Node.js (ESM)
+
+```javascript
+import { Skapi } from 'skapi-js';
+const skapi = new Skapi('SERVICE_ID');
+```
+
 > **Note:** When running Skapi in Node.js, browser-specific features such as WebSocket, WebRTC, and Notifications are not available.