Improve API documentation -- be as clear and concise as chrome.serial

[JayBeavers]

No description provided.

[carloscarcamo]

It would be excellent, if the documentation were improved, It would be easier to understand the use of serial port.

[reconbot]

I assume you mean these http://developer.chrome.com/apps/serial.html they are nice

[programmarchy]

Started documenting on the Wiki at https://github.com/voodootikigod/node-serialport/wiki/Reference using Chrome's docs as a loose guideline.

[reconbot]

Beautiful - I will argue this should live in the readme.md

---

Francis Gulotta
wizard@roborooter.com

On Thu, Nov 28, 2013 at 2:24 PM, Donald Ness notifications@github.comwrote:

Started documenting on the Wiki at
https://github.com/voodootikigod/node-serialport/wiki/Reference using
Chrome's docs as a loose guideline.

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/247#issuecomment-29481772
.

[JayBeavers]

Nice work! I agree with @reconbot that readme.md is probably a better place for it.

[programmarchy]

My only hesitation was that README.md is already pretty lengthy, and provides some overview examples already so I thought a link would be more appropriate. Submitted pull request based on both your recommendations.

[reconbot]

I'm going to close this for now, we've settled on the readme for now.