code.delx.au - gnu-emacs-elpa/blob - packages/websocket/README.org

   1 * Description
   2 This is a elisp library for websocket clients to talk to websocket
   3 servers, and for websocket servers to accept connections from
   4 websocket clients. This library is designed to be used by other
   5 library writers, to write apps that use websockets, and is not useful
   6 by itself.
   7
   8 An example of how to use the library is in the
   9 [[https://github.com/ahyatt/emacs-websocket/blob/master/websocket-functional-test.el][websocket-functional-test.el]] file.
  10
  11 This library is compatible with emacs 23 and 24, although only emacs
  12 24 support secure websockets.
  13
  14 NOTE: Due to FSF attribution restrictions, ERT tests are only not
  15 present in the emacs ELPA repository.  They can only be found in the
  16 github repository at https://github.com/ahyatt/emacs-websocket/.
  17
  18 * Version release checklist
  19
  20 Each version that is released should be checked with this checklist:
  21
  22 - [ ] All ert test passing (see note above on ERT tests)
  23 - [ ] Functional test passing on emacs 23 and 24
  24 - [ ] websocket.el byte compiling cleanly.
  25
  26 * Existing clients:
  27
  28 - [[https://github.com/tkf/emacs-ipython-notebook][Emacs IPython Notebook]]
  29 - [[https://github.com/syohex/emacs-realtime-markdown-viewer][Emacs Realtime Markdown Viewer]]
  30 - [[https://github.com/jscheid/kite][Kite]]
  31
  32 If you are using this module for your own emacs package, please let me
  33 know by editing this file, adding your project, and sending a pull
  34 request to this repository.
  35