[elpa] externals/crdt a25188da61 3/5: Merge branch 'service_doc' into 'master'

[ELPA Syncer]

branch: externals/crdt
commit a25188da610a970f3e267014289457c7da2de2b8
Merge: 3ba890658d 029187c285
Author: Qiantan Hong <qhong@alum.mit.edu>
Commit: Qiantan Hong <qhong@alum.mit.edu>

    Merge branch 'service_doc' into 'master'
    
    doc: Service description and nc/telnet example
    
    See merge request qhong/crdt.el!6
---
 README.org | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/README.org b/README.org
index 61a3b1f700..8a7ce2bd36 100644
--- a/README.org
+++ b/README.org
@@ -58,6 +58,8 @@ If the server has provided the permission (this is the 
default case),
 connected user may also add their buffers to the session via
 =M-x crdt-share-buffer=.
 
+Connection URLs look like =ein://ipaddress:6530=
+
 ** Navigate through sessions
 
 - Sessions :: =M-x crdt-list-sessions= lists all sessions.
@@ -164,3 +166,31 @@ $ ssh -R EXAMPLE.COM:6530:127.0.0.1:6530 EXAMPLE.COM
   #+BEGIN_SRC 
 GatewayPorts yes
   #+END_SRC
+
+- For other tunneling solutions, see 
https://github.com/anderspitman/awesome-tunneling
+
+* Service
+=crdt.el= uses emacs' built in =(make-network-process)= to exchange elisp 
messages between clients, see =crdt--format-message=.
+
+You can see these messages in within emacs with =(setq 
crdt--log-network-traffic t)= and outside emacs with =nc= or =telnet=.
+#+begin_src bash
+nc localhost 6530 <<< '(hello "0.3.0")'
+#+end_src
+
+Demonstrating =(hello)=, =(get)=, and =(leave)=
+#+begin_src bash
+telnet localhost 6530
+...
+(hello "0.3.0")
+
+  (login 2)(add "testfile.org") ....
+
+(get "testfile.org")
+  (sync "testfile.org" (#("FILE CONTENTS ....
+
+(leave 2)
+#+end_src
+
+** Messages
+
+hello, leave, get, cursor, overlay-move, overlay-remove, overlay-put, return, 
var, ready