Skip to content

Commit

Permalink
Fix #20
Browse files Browse the repository at this point in the history
  • Loading branch information
kum-deepak committed Jan 29, 2018
1 parent c97f288 commit 984762a
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 15 deletions.
23 changes: 12 additions & 11 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@ applications.
# Introduction

This library allows you to connect to a STOMP broker over WebSocket. This library
supports full STOMP specifications and all current protocol variants. Most of
supports full STOMP specifications and all current protocol variants. Most
popular messaging brokers support STOMP and STOMP over WebSockets either natively
or using plugins.

In general JavaScript engines at browsers are not amenable to binary protocols,
so using STOMP, which is a text oriented protocol, becomes a reliable option.
In general JavaScript engines in browsers are not friendly to binary protocols,
so using STOMP is a better option because it is a text oriented protocol.

This library was originally developed by [Jeff Mesnil](http://jmesnil.net/).

## Current Status

This library is feature complete and has been in use in production for many years. It
This library is feature complete and has been used in production for many years. It
is actively maintained. You are welcome to file issues and submit pull requests.

## Getting started
Expand All @@ -29,13 +29,13 @@ You may head straight to the
[entry point](https://stomp-js.github.io/stomp-websocket/codo/extra/docs-src/Introduction.md.html).
(or [with frames](https://stomp-js.github.io/stomp-websocket/codo/))

This library comes with a detailed usage instructions. Please find it at
This library comes with detailed usage instructions. Please find it at
[Usage instructions](https://stomp-js.github.io/stomp-websocket/codo/extra/docs-src/Usage.md.html).

If you were using older versions and wish to benefit from newer features, head to
[Upgrading](https://stomp-js.github.io/stomp-websocket/codo/extra/docs-src/Upgrade.md.html).

If you are existing user and will like to deep dive - API Reference for important entities:
If you are an existing user and will like to deep dive - API references for important entities:

* [Stomp](https://stomp-js.github.io/stomp-websocket/codo/mixin/Stomp.html)
* [Client](https://stomp-js.github.io/stomp-websocket/codo/class/Client.html)
Expand All @@ -45,23 +45,23 @@ If you are existing user and will like to deep dive - API Reference for importan
If you are using this library in NodeJS you should definitely check
[NodeJS Legacy](https://stomp-js.github.io/stomp-websocket/codo/extra/docs-src/nodejs.md.html).

## Using with Angular2/4
## Usage with Angular2/4/5

https://github.com/stomp-js/ng2-stompjs is based on this library and exposes entire functionality
https://github.com/stomp-js/ng2-stompjs is based on this library and exposes the entire functionality
offered by this library as Angular Services and rxjs Observables. Both these libraries are maintained
by similar set of contributors.
by a similar set of contributors.

## TypeScript definitions

The npm package includes [TypeScript definitions](https://github.com/stomp-js/stomp-websocket/blob/master/index.d.ts), no need no install separately.
The npm package includes [TypeScript definitions](https://github.com/stomp-js/stomp-websocket/blob/master/index.d.ts), so there is no need no install it separately.

## Change log

Please visit [Change Log](https://stomp-js.github.io/stomp-websocket/codo/extra/docs-src/Change-log.md.html).

## Contributing

If you want to understand the code, develop, contribute. Please visit
If you want to understand the code, develop, or contribute. Please visit
[How to contribute](https://stomp-js.github.io/stomp-websocket/codo/extra/docs-src/Contribute.md.html).

## Authors
Expand All @@ -70,6 +70,7 @@ If you want to understand the code, develop, contribute. Please visit
* [Jeff Lindsay](http://github.com/progrium)
* [Vanessa Williams](http://github.com/fridgebuzz)
* [Deepak Kumar](https://github.com/kum-deepak)
* Astha Deep

## License

Expand Down
4 changes: 3 additions & 1 deletion lib/stomp.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 984762a

Please sign in to comment.