search

englercj / node-esl

FreeSWITCH ESL implementation for Node.js; implements the full Event Socket Library specified in: http://wiki.freeswitch.org/wiki/Esl
http://englercj.github.com/node-esl/
MIT License
170 stars 111 forks source link

This module is where all FS power is, but it's not well documented #88

Open emahuni opened 4 years ago

emahuni commented 4 years ago

For Nodejs this is go to library for FS programming. However, it lacks documentation and this is so painful. I got looking around and found this and thought this might help someone.

https://medium.com/makingtuenti/developing-applications-for-freeswitch-fccbe75ada81

I think this link or the entire article should just be included in the wiki or on the README so that it helps anyone starting out this path to get it right.

This is not the first time I have attempted to use this lib. I always got issues because of this lack of documentation.

englercj commented 4 years ago

This library implements the ESL Spec, so all the functions are what are listed there. All the events are documented here. There are also a number of examples. What is it that you find to be missing?