Question: Where is the rest of the documentation? (#133)
Open
Unknown opened 2 years ago

I'm interested in using the Martin library for a future project. However, the documentation for it looks frighteningly limited.

I found only 3 links scattered across this project's README and the Tigase website's "Contact" page—two were just duplicates of the same limited content that just looked different, and the third was something else that wasn't even about Martin. And the majority of the links on the README are effectively dead, redirecting back to the Tigase homepage instead.

The biggest issue is that the documentation fails to answer my question of: how do I use Martin to make a Jingle call? And it looks like those docs also have an incomplete list of supported XEPs, as compared to the list in the README.

Where can I find more complete information on how to use the full functionality of this library?

Unknown commented 2 years ago

Documentation of Martin library is currently limited to the base usage and is based on the stable version of the library. Library is currently evolving with a huge rewrite to the new async-await API available in newer versions of Swift to simplify its usage.

Jingle call implementation requires usage of external library to establish p2p connection for VoIP. For that in case of the clients which we are developing we are using WebRTC. As the examples of the Jingle implementation, you can see https://github.com/tigase/beagle-im and https://github.com/tigase/siskin-im.

issue 1 of 1
Issue Votes (0)
Watchers (0)
Reference
tigase/_libraries/Martin#133
Please wait...
Page is in error, reload to recover