Readme file - Githubissues

blockcoders / nestjs-websocket

Websocket Client for NestJS based on ws

Apache License 2.0

20 stars 12 forks source link

Readme file #1

Closed AnnRiera closed 3 years ago

AnnRiera commented 3 years ago

PR Checklist

Please check if your PR fulfills the following requirements:

[x] The commit message follows our guidelines: CONTRIBUTING.md
[x] Tests for the changes have been added (for bug fixes / features)
[x] Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Other... Please describe:

What is the current behavior?

Currently the repo has no documentation.

Issue Number: N/A

What is the new behavior?

This PR includes a README.file that explains how to use this library.

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information