[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] 49/119: small updates to README and NOTES
From: |
Eric Schulte |
Subject: |
[elpa] 49/119: small updates to README and NOTES |
Date: |
Mon, 10 Mar 2014 16:57:20 +0000 |
eschulte pushed a commit to branch master
in repository elpa.
commit b5a5405d1c2bc7011c83441e144c53a222eebee9
Author: Eric Schulte <address@hidden>
Date: Mon Dec 30 22:00:24 2013 -0700
small updates to README and NOTES
---
NOTES | 26 ++++++++------------------
README | 13 ++++++++-----
2 files changed, 16 insertions(+), 23 deletions(-)
diff --git a/NOTES b/NOTES
index 78030da..1cf10f4 100644
--- a/NOTES
+++ b/NOTES
@@ -1,16 +1,16 @@
-*- org -*-
* Notes
-* Tasks [7/9]
-** STARTED Documentation [0/4]
-- [ ] introduction
-- [ ] handlers
-- [ ] request headers
-- [ ] usage examples
-- [ ] list of functions
+* Tasks [8/9]
+** DONE Documentation [6/6]
+- [X] introduction
+- [X] handlers
+- [X] request headers
+- [X] usage examples
+- [X] list of functions
Notes to touch upon
-- [ ] how to set content type
+- [X] how to set content type
** DONE Handle POST requests
1. read standard for POST data
@@ -57,13 +57,3 @@ the test suite.
** TODO use gnutls for https
I think this should work.
-* Documentation
-** Writing Handlers
-*** Matching
-*** Handler Functions
-At any time one can throw =close-connection= to abort the handler and
-close the conncetion. If the keyword =:keep-open= is thrown, then the
-handler aborts, but the connection isn't closed.
-
-A return value of =:keep-open= will keep the connection open,
-otherwise it is closed when the handler returns.
diff --git a/README b/README
index 5c47109..cf081c0 100644
--- a/README
+++ b/README
@@ -7,19 +7,22 @@ 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.
+ 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.
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].
+ [1] https://github.com/eschulte/el-sprunge
+ [2] https://github.com/eschulte/org-ehtml/tree/emacs-web-server
+
DOCUMENTATION
Run `make doc' to build the texinfo documentation, also available
online [3].
-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
- [elpa] 35/119: cleaned up header/param parsing, (continued)
- [elpa] 35/119: cleaned up header/param parsing, Eric Schulte, 2014/03/10
- [elpa] 37/119: fixed tests, running and passing, Eric Schulte, 2014/03/10
- [elpa] 39/119: removed extra comments from examples, Eric Schulte, 2014/03/10
- [elpa] 40/119: moving around examples, Eric Schulte, 2014/03/10
- [elpa] 42/119: Makefile integration, Eric Schulte, 2014/03/10
- [elpa] 44/119: note, Eric Schulte, 2014/03/10
- [elpa] 43/119: more, Eric Schulte, 2014/03/10
- [elpa] 41/119: including examples in documentation, Eric Schulte, 2014/03/10
- [elpa] 47/119: even more documentation and examples, Eric Schulte, 2014/03/10
- [elpa] 48/119: update README, Eric Schulte, 2014/03/10
- [elpa] 49/119: small updates to README and NOTES,
Eric Schulte <=
- [elpa] 50/119: MAYBE incremental handler calls, Eric Schulte, 2014/03/10
- [elpa] 46/119: more documentation and examples, Eric Schulte, 2014/03/10
- [elpa] 51/119: renaming files, Eric Schulte, 2014/03/10
- [elpa] 53/119: added commentary, Eric Schulte, 2014/03/10
- [elpa] 55/119: update link in README, Eric Schulte, 2014/03/10
- [elpa] 54/119: doc tweaks, Eric Schulte, 2014/03/10
- [elpa] 45/119: new request object, Eric Schulte, 2014/03/10
- [elpa] 56/119: fix ports in examples, Eric Schulte, 2014/03/10
- [elpa] 58/119: note: shouldn't use BASIC authentication w/o HTTPS, Eric Schulte, 2014/03/10
- [elpa] 59/119: notes about security & authentication options, Eric Schulte, 2014/03/10