Skip to content

Commit 29464d3

Browse files
author
Deepak Kumar
committed
Refined STOMP.js documentation: updated terminology for consistency, improved clarity in guides, corrected Angular references, and aligned style across sections.
1 parent 6594d60 commit 29464d3

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

index.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,31 @@
11
---
22
layout: single
33
date: 2025-03-22 19:42:22 +0530
4-
title: 'StompJs Family'
4+
title: 'STOMP.js Family'
55
author_profile: true
66
---
77

8-
These libraries provide [STOMP] over [Websocket] connectivity for web browsers or other Javascript-based environments.
8+
These libraries provide [STOMP] over [WebSocket] connectivity for web browsers and other JavaScript runtimes.
99

1010
[stompjs] is the core JavaScript library.
11-
[rx-stomp] is a wrapper that exposes functionality as [RxJS] primitives.
12-
If you are already using [RxJS] in your project or are familiar with it, check out [rx-stomp].
11+
[rx-stomp] is a wrapper that exposes the same functionality as [RxJS] primitives.
12+
If you already use [RxJS] or prefer reactive patterns, start with [rx-stomp].
1313

1414
## Getting started
1515

16-
Please try the following guides:
16+
Start here:
1717

1818
- [Using StompJS] - a step-by-step guide.
19-
- [Using rx-stomp with Angular] — originally written for Angular13,
20-
should work with Angular 7+.
19+
- [Using rx-stomp with Angular] — originally written for Angular 13; works with Angular 7+.
2120
- Guide to [Connection status in ng2-stompjs].
2221
- Guide to [How to Use RxStomp with React](https://www.freecodecamp.org/news/build-chat-app-with-stomp-and-react/).
2322

24-
All these guides are written by the maintainers of these projects and follow best practices.
23+
All of these guides are written by the maintainers and follow best practices.
2524

2625
Samples:
2726

2827
- [Samples](https://github.com/stomp-js/samples/) for [stompjs] and [rx-stomp].
29-
- [Sample](https://github.com/stomp-js/rx-stomp-angular) for [rx-stomp] with Angular 7+.
28+
- [Sample](https://github.com/stomp-js/rx-stomp-angular) for [rx-stomp] with Angular (7+).
3029
- [Sample](https://gitlab.com/harsh183/rxstomp-react-tutorial) for [rx-stomp] with React.
3130

3231
[API documentation](/api-docs/latest/) for NPM released versions.
@@ -39,12 +38,11 @@ Samples:
3938

4039
## Other topics
4140

42-
- Read the [FAQs]. These cover varied topics.
43-
- List of [Polyfills] — you may need these for some environments.
44-
- Set of additional notes for using these libraries with [SockJS].
45-
- One of my favorites, but not widely used, excellent support for
46-
[Remote Procedure Calls].
47-
- An article devoted to specific issues posed by [React Native].
41+
- Read the [FAQs] — a curated list of common questions and answers.
42+
- List of [Polyfills] — you may need these in some environments.
43+
- Notes on using these libraries with [SockJS].
44+
- Support for [Remote Procedure Calls] — powerful but less commonly used.
45+
- Notes for using these libraries with [React Native].
4846

4947
[stomp]: https://stomp.github.io/index.html
5048
[websocket]: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket

0 commit comments

Comments
 (0)