From 40a5edb37fdeaababa8a3b02be48d49194b1b986 Mon Sep 17 00:00:00 2001
From: winlin <winlin@vip.126.com>
Date: Sun, 2 Mar 2014 00:15:09 +0800
Subject: [PATCH] update readme.

---
 README.md                      | 3 ++-
 trunk/src/libs/srs_librtmp.hpp | 8 ++++++++
 2 files changed, 10 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 4f3ace3f4..13bda0394 100755
--- a/README.md
+++ b/README.md
@@ -317,7 +317,7 @@ Supported operating systems and hardware:
 22. Player, publisher(encoder), and demo pages(jquery+bootstrap). <br/>
 23. Demo video meeting or chat(SRS+cherrypy+jquery+bootstrap). <br/>
 24. [dev] Full documents in wiki, in chineses. <br/>
-25. [dev] Support RTMP(publish) library<br/>
+25. [dev] Support RTMP(play-publish) library: srs-librtmp<br/>
 26. [plan] Support RTSP(RTP, SDP)<br/>
 27. [plan] Support system utest<br/>
 28. [plan] Support HLS cluster, use RTMP ATC to generate the TS<br/>
@@ -381,6 +381,7 @@ See also: [Performance Test Guide](https://github.com/winlinvip/simple-rtmp-serv
 * nginx v1.5.0: 139524 lines <br/>
 
 ### History
+* v1.0, 2014-03-02, srs-librtmp, client publish/play library like librtmp.
 * v1.0, 2014-03-01, modularity, extract core/kernel/os/protocol/drm/app/main module.
 * v1.0, 2014-02-28, support arm build(SRS/ST), add ssl to 3rdparty package.
 * v1.0, 2014-02-28, add wiki [BuildArm](https://github.com/winlinvip/simple-rtmp-server/wiki/Build), [FFMPEG](https://github.com/winlinvip/simple-rtmp-server/wiki/FFMPEG), [Reload](https://github.com/winlinvip/simple-rtmp-server/wiki/Reload)
diff --git a/trunk/src/libs/srs_librtmp.hpp b/trunk/src/libs/srs_librtmp.hpp
index 5a03d4de0..a439c6ca9 100644
--- a/trunk/src/libs/srs_librtmp.hpp
+++ b/trunk/src/libs/srs_librtmp.hpp
@@ -28,6 +28,14 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #include <srs_librtmp.h>
 */
 
+/**
+* srs-librtmp is a librtmp like library,
+* used to play/publish rtmp stream from/to rtmp server.
+* socket: use sync and block socket to connect/recv/send data with server.
+* depends: no need other libraries; depends on ssl if use srs_complex_handshake.
+* thread-safe: no
+*/
+
 #ifdef __cplusplus
 extern "C"{
 #endif