@stomp/stompjs 7.1.1 → 7.2.0

package/README.md

@@ -1,137 +1,153 @@
 # STOMP.js
 
-[![Firefox, Chrome](https://github.com/stomp-js/stompjs/actions/workflows/linux.yml/badge.svg?branch=develop)](https://github.com/stomp-js/stompjs/actions/workflows/linux.yml)
-[![Safari, Edge](https://github.com/stomp-js/stompjs/actions/workflows/osx.yml/badge.svg?branch=develop)](https://github.com/stomp-js/stompjs/actions/workflows/osx.yml)
-[![NodeJS Test](https://github.com/stomp-js/stompjs/actions/workflows/node-js.yml/badge.svg?branch=develop)](https://github.com/stomp-js/stompjs/actions/workflows/node-js.yml)
-[![API docs refresh](https://github.com/stomp-js/stompjs/actions/workflows/docs-refresh.yml/badge.svg?branch=develop)](https://github.com/stomp-js/stompjs/actions/workflows/docs-refresh.yml)
+[![Build Status - Firefox, Chrome](https://github.com/stomp-js/stompjs/actions/workflows/linux.yml/badge.svg?branch=develop)](https://github.com/stomp-js/stompjs/actions/workflows/linux.yml)
+[![Build Status - Safari, Edge](https://github.com/stomp-js/stompjs/actions/workflows/osx.yml/badge.svg?branch=develop)](https://github.com/stomp-js/stompjs/actions/workflows/osx.yml)
+[![Node.js Tests](https://github.com/stomp-js/stompjs/actions/workflows/node-js.yml/badge.svg?branch=develop)](https://github.com/stomp-js/stompjs/actions/workflows/node-js.yml)
+[![API Docs Refresh](https://github.com/stomp-js/stompjs/actions/workflows/docs-refresh.yml/badge.svg?branch=develop)](https://github.com/stomp-js/stompjs/actions/workflows/docs-refresh.yml)
 
-This library provides a STOMP over WebSocket client for Web browser and node.js applications.
+**STOMP.js** is a fully-fledged STOMP over WebSocket library for **browsers** and **Node.js**, providing seamless integration with STOMP protocol-compliant messaging brokers.
 
-Please visit https://stomp-js.github.io/ for guides, FAQs and API docs.
+## Table of Contents
 
-# Introduction
+- [Introduction](#introduction)
+- [Features](#features)
+- [Getting Started](#getting-started)
+    - [Browser](#browser)
+    - [Node.js](#nodejs)
+- [Documentation](#documentation)
+- [Upgrading](#upgrading)
+- [Usage with RxJS](#usage-with-rxjs)
+- [TypeScript Support](#typescript-support)
+- [Changelog](#changelog)
+- [Contributing](#contributing)
+- [Authors](#authors)
+- [License](#license)
 
-This library allows you to connect to a STOMP broker over WebSocket. This library
-supports complete STOMP specifications including all current protocol variants. Most
-popular messaging brokers support STOMP and STOMP over WebSockets out-of-the-box
-or using plugins.
+## Introduction
+
+This library enables clients to connect to STOMP brokers over WebSocket (or TCP). It fully implements the STOMP protocol specifications (v1.0, v1.1, and v1.2), making it compatible with any broker that supports STOMP or STOMP over WebSocket.
+
+Popular brokers like RabbitMQ, ActiveMQ, and others provide support for STOMP and STOMP over WebSockets out-of-the-box.
 
 ## Features
 
-- Simple API to interact with the Stomp protocol
-- Support for v1.2, v1.1 and v1.0 of the Stomp protocol
-- Support for fallback options in case of WebSocket unavailable
-- Browser and Node.js support
-- Option to use STOMP over TCP
-- Binary payload support
+- Simple and intuitive API for interacting with the STOMP protocol
+- Support for STOMP protocol versions: **1.2**, **1.1**, and **1.0**
+- Support for fallback options  when WebSocket is unavailable
+- Supports both **browser** and **Node.js** environments
+- Option to connect using **STOMP over TCP**
+- Full support for **binary payloads**
+- Compatible with RxJS for reactive programming
 
-## Usage
+## Getting Started
+
+This section provides a quick guide to integrating STOMP.js into your **browser** or **Node.js** application.
 
 ### Browser
 
-```html
-<!--
-    JSPM Generator Import Map
-    Edit URL: https://generator.jspm.io/#U2NgYGBkDM0rySzJSU1hcCguyc8t0AeTWcUO5noGega6SakliaYAYTzJAykA
-  -->
-<script type="importmap">
-  {
-    "imports": {
-      "@stomp/stompjs": "https://ga.jspm.io/npm:@stomp/stompjs@7.0.0/esm6/index.js"
-    }
-  }
-</script>
-
-<!-- ES Module Shims: Import maps polyfill for modules browsers without import maps support (all except Chrome 89+) -->
-<script
-  async
-  src="https://ga.jspm.io/npm:es-module-shims@1.5.1/dist/es-module-shims.js"
-  crossorigin="anonymous"
-></script>
-
-<script type="module">
-  import { Client } from '@stomp/stompjs';
-
-  const client = new Client({
-    brokerURL: 'ws://localhost:15674/ws',
-    onConnect: () => {
-      client.subscribe('/topic/test01', message =>
-        console.log(`Received: ${message.body}`)
-      );
-      client.publish({ destination: '/topic/test01', body: 'First Message' });
-    },
-  });
-
-  client.activate();
-</script>
-```
-
-### NodeJS
-
-```bash
-$ npm install @stomp/stompjs ws
-```
-
-```javascript
-import { Client } from '@stomp/stompjs';
-
-import { WebSocket } from 'ws';
-Object.assign(global, { WebSocket });
-
-const client = new Client({
-  brokerURL: 'ws://localhost:15674/ws',
-  onConnect: () => {
-    client.subscribe('/topic/test01', message =>
-      console.log(`Received: ${message.body}`)
-    );
-    client.publish({ destination: '/topic/test01', body: 'First Message' });
-  },
-});
-
-client.activate();
-```
-
-## Further information
-
-The API documentation is hosted as GitHub pages for the StompJS family of libraries.
-You may head straight to the https://stomp-js.github.io/api-docs/latest/
-
-This library comes with detailed usage instructions. Please find it at
-[Usage instructions](https://stomp-js.github.io/guide/stompjs/using-stompjs-v5.html).
-Check out other guides at https://stomp-js.github.io/.
-
-There is quite detailed API documentation,
-you should start at https://stomp-js.github.io/api-docs/latest/classes/Client.html.
+To use STOMP.js in a browser:
+
+1. Add the following in your HTML file:
+   ```html
+   <script type="importmap">
+     {
+       "imports": {
+         "@stomp/stompjs": "https://ga.jspm.io/npm:@stomp/stompjs@7.0.0/esm6/index.js"
+       }
+     }
+   </script>
+   <script
+     async
+     src="https://ga.jspm.io/npm:es-module-shims@1.5.1/dist/es-module-shims.js"
+     crossorigin="anonymous"
+   ></script>
+   ```
+
+2. Use the library:
+   ```javascript
+   import { Client } from '@stomp/stompjs';
+
+   const client = new Client({
+     brokerURL: 'ws://localhost:15674/ws',
+     onConnect: () => {
+       client.subscribe('/topic/test01', message =>
+         console.log(`Received: ${message.body}`)
+       );
+       client.publish({ destination: '/topic/test01', body: 'First Message' });
+     },
+   });
+
+   client.activate();
+   ```
+
+### Node.js
+
+To use STOMP.js in a Node.js environment:
+
+1. Install the package:
+   ```bash
+   npm install @stomp/stompjs ws
+   ```
+
+2. Use it in your application:
+   ```javascript
+   import { Client } from '@stomp/stompjs';
+
+   import { WebSocket } from 'ws';
+   Object.assign(global, { WebSocket });
+
+   const client = new Client({
+     brokerURL: 'ws://localhost:15674/ws',
+     onConnect: () => {
+       client.subscribe('/topic/test01', message =>
+         console.log(`Received: ${message.body}`)
+       );
+       client.publish({ destination: '/topic/test01', body: 'First Message' });
+     },
+   });
+
+   client.activate();
+   ```
+
+---
+
+## Documentation
+
+Comprehensive documentation can be found at: [STOMP.js Documentation](https://stomp-js.github.io/)
+
+- **API Overview**: [API Docs (latest)](https://stomp-js.github.io/api-docs/latest/)
+- **Usage Guide**: [Guide to Using STOMP.js](https://stomp-js.github.io/guide/stompjs/using-stompjs-v5.html)
+- **Feature Guides**: Explore additional guides at [https://stomp-js.github.io/](https://stomp-js.github.io/)
 
 ## Upgrading
 
-if you were using an older version of this library, you would need to make changes
-to your code. Head to
-[Upgrading](https://stomp-js.github.io/#upgrading).
+If you are updating from an older version of STOMP.js, review the [Upgrading Guide](https://stomp-js.github.io/#upgrading) for any required changes.
 
 ## Usage with RxJS
 
-https://github.com/stomp-js/rx-stomp is based on this library and exposes the entire functionality
-offered by this library as RxJS Observables.
+[Rx-Stomp](https://github.com/stomp-js/rx-stomp) builds upon this library, exposing all its features as **RxJS Observables**, enabling reactive programming patterns.
 
-## TypeScript definitions
+## TypeScript Support
 
-The npm package includes TypeScript definitions, so there is no need to install it separately.
+STOMP.js includes built-in TypeScript definitions, eliminating the need for external type definition files. Begin coding with TypeScript out-of-the-box!
 
-## Change-log
+## Changelog
 
-Please visit [Change Log](Change-log.md).
+Visit the [Change Log](Change-log.md) for information about changes, improvements, and fixes in recent releases.
 
 ## Contributing
 
-If you want to understand the code, develop, or contribute. Please visit
-[How to contribute](Contribute.md).
+Thinking of contributing to STOMP.js? Great! To get started:
+
+- Read the [Contributing Guide](Contribute.md) for development instructions.
+- Report bugs or suggest features by creating an issue on GitHub.
+
+We welcome contributions from the community!
 
 ## Authors
 
-- [Jeff Mesnil](http://jmesnil.net/)
-- [Jeff Lindsay](http://github.com/progrium)
-- [Vanessa Williams](http://github.com/fridgebuzz)
+This library is made possible by these amazing contributors:
+
 - [Deepak Kumar](https://github.com/kum-deepak)
 - [Astha Deep](https://github.com/astha183)
 - [Dillon Sellars](https://github.com/dillon-sellars)
@@ -145,7 +161,14 @@ If you want to understand the code, develop, or contribute. Please visit
 - [Nikos Epping](https://github.com/Nikos410)
 - [Tom Pachtner](https://github.com/tomamatics)
 - [David Nussio](https://github.com/davidnussio)
+- [Camille Drapier](https://github.com/CamilleDrapier)
+- [chai min](https://github.com/minchai23)
+- [umsungjun](https://github.com/umsungjun)
+- [tomek3e](https://github.com/tomek3e)
+- [Samuel Yinger](https://github.com/GoldenSunX)
+
+This library is originally based on [stompjs](https://github.com/jmesnil/stomp-websocket) by [Jeff Mesnil](http://jmesnil.net/) with enhancements and bug fixes from [Jeff Lindsay](http://github.com/progrium) and [Vanessa Williams](http://github.com/fridgebuzz).
 
 ## License
 
-[License](LICENSE) - Apache-2.0
+Licensed under the **Apache-2.0 License**. See the [LICENSE file](LICENSE) for details.