fb-messenger-e2ee 0.1.0 → 0.1.2

package/README.md

@@ -1,8 +1,11 @@
 # FME - FB Messenger E2EE
 
-[![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue.svg)](https://www.typescriptlang.org/)
-[![Bun](https://img.shields.io/badge/Bun-1.0+-black.svg)](https://bun.sh/)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![npm version](https://img.shields.io/npm/v/fb-messenger-e2ee?style=flat-square)](https://www.npmjs.com/package/fb-messenger-e2ee)
+[![github version](https://img.shields.io/github/package-json/v/HerokeyVN/fb-messenger-e2ee?label=github&style=flat-square)](https://github.com/HerokeyVN/fb-messenger-e2ee)
+[![npm downloads](https://img.shields.io/npm/dm/fb-messenger-e2ee?style=flat-square)](https://www.npmjs.com/package/fb-messenger-e2ee)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue?style=flat-square)](https://www.typescriptlang.org/)
+[![Bun](https://img.shields.io/badge/Bun-1.0+-black?style=flat-square)](https://bun.sh/)
+[![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL--3.0-blue?style=flat-square)](https://www.gnu.org/licenses/agpl-3.0)
 
 **FME - FB Messenger E2EE** is a TypeScript/Bun toolkit focused on Facebook Messenger E2EE flows built on Noise, WA-binary, protobuf, and the Signal Protocol. Plaintext/non-E2EE messaging is intentionally left to `fca-unofficial` directly.
 
@@ -25,7 +28,7 @@
 - **Language**: [TypeScript](https://www.typescriptlang.org/)
 - **Encryption**: [@signalapp/libsignal-client](https://github.com/signalapp/libsignal-client)
 - **Protocol**: ProtobufJS + manual WA-binary/protobuf encoders
-- **Auth bootstrap bridge**: [fca-unofficial](https://github.com/VangBanLaNhat/fca-unofficial) is used internally only for appState login/CAT bootstrap; use it directly for non-E2EE messaging.
+- **Auth bootstrap bridge**: [fca-unofficial](https://github.com/VangBanLaNhat/fca-unofficial) is used internally only for appState login/CAT bootstrap
 
 ---
 
@@ -41,6 +44,18 @@ bun add fb-messenger-e2ee
 
 ### 2. Basic Usage
 
+
+#### ESM (TypeScript / Modern Node.js)
+```typescript
+import { FBClient } from "fb-messenger-e2ee";
+```
+
+#### CommonJS (Legacy Node.js)
+```javascript
+const { FBClient } = require("fb-messenger-e2ee");
+```
+
+#### Example
 ```typescript
 import { FBClient } from "fb-messenger-e2ee";
 
@@ -127,10 +142,23 @@ src/
 
 ---
 
-## Testing
+## Build & Development
 
+### Build
+Generate ESM and CommonJS bundles in the `dist/` directory:
+```bash
+npm run build
+# or
+bun run build
+```
+
+### Type Check
 ```bash
 npm run typecheck
+```
+
+### Testing
+```bash
 npm test -- --runInBand
 ```
 
@@ -150,4 +178,4 @@ For the API reference and operational notes, see [DOCS.md](./DOCS.md).
 
 ## License
 
-MIT © [VangBanLaNhat](https://github.com/VangBanLaNhat)
+Licensed under the [GNU Affero General Public License v3.0](./LICENSE)