nodeSolidServer / node-solid-ws

Node/Javascript implementation of Websockets for Solid
http://npm.im/solid-ws
8 stars 6 forks source link

Typo in solidWs usage in documentation #26

Open melvincarvalho opened 2 days ago

melvincarvalho commented 2 days ago

Description:
In the usage examples within the README, the solidWs function is imported as SolidWs but used as solidWs. For consistency and convention in JavaScript (camelCase for functions), the import should be changed to solidWs.

Proposed fix:
In the "Short way" and "Long way" examples, update the import statement to:

var solidWs = require('solid-ws')

This will maintain consistency with the function call solidWs(server).