harlanc / xiu

A simple,high performance and secure live media server in pure Rust (RTMP[cluster]/RTSP/WebRTC[whip/whep]/HTTP-FLV/HLS).🦀
https://www.rustxiu.com
MIT License
1.61k stars 168 forks source link

Lack of documentation #37

Open ehuff700 opened 1 year ago

ehuff700 commented 1 year ago

Am I crazy or is there a total lack of documentation for the rtmp module? I would like to extend the functionality of that module and use it within my program but can't find any documentation for it anywhere.

kaitlynia commented 2 months ago

I agree there should be more documentation. There are examples of config files on the docs website, but not much information about the options within them. Also, the "Quick Start" link on the homepage of the docs website 404s.

harlanc commented 2 months ago

@kaitlynia Please try the "Quick Start" link again to see if it's fixed or not https://www.rustxiu.com/docs/getting-started/quickstart