aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README19
1 files changed, 17 insertions, 2 deletions
diff --git a/README b/README
index a267fad..5fb88ea 100644
--- a/README
+++ b/README
@@ -18,7 +18,9 @@ The current interface for this webserver is contained in
http_Request.h
(Note that this will change once we have an agreed common protocol for
-other thorns to talk to web-serving thorns.)
+other thorns to talk to web-serving thorns.) There are also utility
+interface for parameter steering and HTTP authentication, which are
+described in the files in the doc directory.
The primary mechanism is to
@@ -105,7 +107,8 @@ file.
Structure of the thorn:
----------------------
-The thorn is split into two parts - web serving and content provision.
+The thorn is split into three parts - basic web serving, utilities,
+and content provision
Web serving:
-----------
@@ -124,6 +127,17 @@ The above files should not need to be touched apart from debugging
purposes, to add more HTTP methods, or otherwise to enhance the
interaction with the network and protocols.
+Utilities:
+_________
+
+The web server provided utilities to help content provision -
+
+Steer.c - parameter steering interface
+ - see doc/Steering.txt
+
+Authorisation.c - HTTP authentication
+ - see doc/Auth.txt
+
Content Provision:
-----------------
@@ -136,3 +150,4 @@ provide content. In principle this could be in another thorn, but
that should wait until we have an agreed set of interfaces to allow
web-server thorns to be interchangeable, at least at compile time, but
hopefully at run-time.
+