X-Git-Url: https://code.delx.au/gnu-emacs-elpa/blobdiff_plain/807a1f633d9d53d81fc0bce18226e17b4fae20b8..d6a27ca7f4c668a6525d95f484c3a21c1b87b8f2:/README diff --git a/README b/README index 5c471096b..573a70ebf 100644 --- a/README +++ b/README @@ -7,19 +7,26 @@ REQUIREMENTS Emacs 24.3 or later. STATUS - This is a new project without much testing or active use. That - said it handles both GET and POST requests and should be usable. + Supports HTTP GET and POST requests including URL-encoded + parameters, multipart/form data and file uploads. Supports web + sockets. Reasonably performant, faster than Elnode [1]. This is + a new project without much extended use so there are likely bugs + and potentially security issues. That said it consists of little + more than HTTP header parsing logic perched atop Emacs' existing + network process primitives, so it should be fairly robust. + + [1] http://eschulte.github.io/emacs-web-server/benchmark/ EXAMPLES See the examples/ directory in this repository. The Emacs Web - Server is also used to run a paste server [1] and serve editable - Org-mode pages [2]. + Server is also used to run a paste server [2] and serve editable + Org-mode pages [3]. + + [2] https://github.com/eschulte/el-sprunge + [3] https://github.com/eschulte/org-ehtml DOCUMENTATION Run `make doc' to build the texinfo documentation, also available - online [3]. + online [4]. -FOOTNOTES - [1] https://github.com/eschulte/el-sprunge - [2] https://github.com/eschulte/org-ehtml/tree/emacs-web-server - [3] http://eschulte.github.io/emacs-web-server + [4] http://eschulte.github.io/emacs-web-server