angular-socket-io icon indicating copy to clipboard operation
angular-socket-io copied to clipboard

ReadMe is misguiding

Open lekhnath opened this issue 10 years ago • 3 comments

When I tried to configure the socketProvider as explained in the doc I got an error message injector:modulerr.

angular.module('myApp', [
  'btford.socket-io'
]).
config(function (socketProvider) {
  socketProvider.prefix('');
});

When I tried socketFactoryProvider instead, the injector:modulerr error seems gone but the prefix and other methods mentioned in readme are undefined. I found the doc misguiding. Am I doing something wrong, how can I get it work ??

lekhnath avatar Aug 12 '14 10:08 lekhnath

The readme uses 'socketFactory' not 'socketProvider'. I just started using this library but have been able to successfully get basic functionality up using 'sockteFactory' you should try that instead.

WonderPanda avatar Aug 14 '14 18:08 WonderPanda

would anyone like to put together a PR to improve the docs?

btford avatar Aug 14 '14 18:08 btford

@btford Yes it would help alot. Right now they are very hard to understand. Also an example of sending and receiving messages would be nice. They seem easy but getting it working the first time is a pain.

epelc avatar Sep 03 '14 20:09 epelc