ditesh / node-poplib

POP3 client library for Node.js
MIT License
128 stars 44 forks source link

Confusion in docs #4

Closed AVBelyy closed 11 years ago

AVBelyy commented 11 years ago

README.md says that to initialize POP3Client class we need to pass true as tls' value, like this:

client = new POP3Client(port, host, true);

But when I tried this, nothing happened. Then I looked through the source code and realized that it should be written that way:

client = new POP3Client(port, host, {enabletls: true});

I guess you need to say in README.md that tls is actually options and tell more about available parameters.