Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Question: Where is the rest of the documentation? #21

Open
HilbertIdeals5 opened this issue Feb 2, 2023 · 2 comments
Open

Question: Where is the rest of the documentation? #21

HilbertIdeals5 opened this issue Feb 2, 2023 · 2 comments
Assignees

Comments

@HilbertIdeals5
Copy link

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?

@hantu85
Copy link
Contributor

hantu85 commented Feb 7, 2023

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.

@qiuping345
Copy link

Hello @hantu85
Thanks for your work on Tigase Martin. It's awesome. I tried Siskin IM recently, I am impressed. I am working on adding Martin V3.2.4 to my project, but I found the document is for V1.0.0. The example code won't work. I struggled to authenticate with success, but I cannot figure out how to send out a 1-1 message. Can you update the documentation per the latest release? I'd appreciate it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants