update

[emacs-init.git] / elpa / websocket-1.8 / README.org

diff --git a/elpa/websocket-1.8/README.org b/elpa/websocket-1.8/README.org
new file mode 100644 (file)
index 0000000..db5abba
--- /dev/null
+++ b/elpa/websocket-1.8/README.org
@@ -0,0 +1,35 @@
+* Description
+This is a elisp library for websocket clients to talk to websocket
+servers, and for websocket servers to accept connections from
+websocket clients. This library is designed to be used by other
+library writers, to write apps that use websockets, and is not useful
+by itself.
+
+An example of how to use the library is in the
+[[https://github.com/ahyatt/emacs-websocket/blob/master/websocket-functional-test.el][websocket-functional-test.el]] file.
+
+This library is compatible with emacs 23 and 24, although only emacs
+24 support secure websockets.
+
+NOTE: Due to FSF attribution restrictions, ERT tests are only not
+present in the emacs ELPA repository.  They can only be found in the
+github repository at https://github.com/ahyatt/emacs-websocket/.
+
+* Version release checklist
+
+Each version that is released should be checked with this checklist:
+
+- [ ] All ert test passing (see note above on ERT tests)
+- [ ] Functional test passing on emacs 23 and 24
+- [ ] websocket.el byte compiling cleanly.
+
+* Existing clients:
+
+- [[https://github.com/tkf/emacs-ipython-notebook][Emacs IPython Notebook]]
+- [[https://github.com/syohex/emacs-realtime-markdown-viewer][Emacs Realtime Markdown Viewer]]
+- [[https://github.com/jscheid/kite][Kite]]
+
+If you are using this module for your own emacs package, please let me
+know by editing this file, adding your project, and sending a pull
+request to this repository.
+