Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ReadMe is misguiding #74

Open
lekhnath opened this issue Aug 12, 2014 · 3 comments
Open

ReadMe is misguiding #74

lekhnath opened this issue Aug 12, 2014 · 3 comments

Comments

@lekhnath
Copy link

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 lekhnath changed the title Documentation is misguiding ReadMe is misguiding Aug 14, 2014
@WonderPanda
Copy link

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.

@btford
Copy link
Owner

btford commented Aug 14, 2014

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

@epelc
Copy link

epelc commented Sep 3, 2014

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants