Make the readme more friendly

coopernurse / node-pool

Generic resource pooling for node.js

2.38k stars 259 forks source link

Make the readme more friendly #117

Open sandfox opened 8 years ago

sandfox commented 8 years ago

The readme could be a little more friendly to first timers and the docs can be confusing to people who are not familiar with resource/object pooling.

Make the the first example as simple as possible
copy and add relevant readme code blocks into an examples folder
make the API docs clearer

blakeembrey commented 8 years ago

FWIW, I was just reviewing the options since 3.0 and it looks like they're outdated. There's a non-existing option with "remove me" and conflicting definitions of idleTimeoutMillis.

Edit: There's also a few example typos (missing parens, e.g. thenfunction) and also duplicated "draining" documentation.

sandfox commented 8 years ago

@blakeembrey thanks for spotting this. I got a little tired towards the end of pushing this out! If you have any time I'd happily accept some PR's but I'll also try to get round to fixing them up too.

sandfox commented 8 years ago

fixed up all the things mentioned!

jema28 commented 6 years ago

I'm gonna have a look :)

jema28 commented 6 years ago

Here are the changes: PR #213 😄