Doc fix

[Lucu.git] / Network / HTTP / Lucu.hs

diff --git a/Network/HTTP/Lucu.hs b/Network/HTTP/Lucu.hs
index d47854f708997be73e623ca5c572876f7d05293f..efae41a90e499156cc2e62d8ad42b4a6db63f773 100644 (file)
--- a/Network/HTTP/Lucu.hs
+++ b/Network/HTTP/Lucu.hs
@@ -6,49 +6,47 @@
 --   [/Full support of HTTP\/1.1/] Lucu supports request pipelining,
 --   chunked I\/O, ETag comparison and \"100 Continue\".
 --
---   [/Performance/] Lucu doesn't fork\/exec to handle requests like
---   CGI. It just spawns a new thread. Inter-process communication is
---   done with STM.
+--   [/Performance/] Lucu is carefully designed to gain a good
+--   performance.
 --
---   [/Affinity for RESTafarians/] Lucu is a carefully designed
---   web server for RESTful applications.
+--   [/Affinity for RESTafarians/] Lucu is specifically designed to be
+--   suitable for RESTful applications.
 --
 --   [/SSL connections/] Lucu can handle HTTP connections over SSL
 --   layer.
 --
 -- Lucu is not a replacement for Apache or lighttpd. It is intended to
--- be used to create an efficient web-based RESTful application
--- without messing around FastCGI. It is also intended to be run
--- behind a reverse-proxy so it doesn't have the following (otherwise
--- essential) facilities:
+-- be used to build an efficient web-based RESTful application. It is
+-- also intended to be run behind a reverse-proxy so it doesn't have
+-- the following (otherwise essential) facilities:
 --
---   [/Logging/] Lucu doesn't log any requests from any clients.
+--   [/Logging/] Lucu doesn't write logs of any requests from any
+--   clients.
 --
 --   [/Client Filtering/] Lucu always accepts any clients. No IP
 --   filter is implemented.
 --
 --   [/Bandwidth Limitting/] Lucu doesn't limit bandwidth it consumes.
 --
---   [/Protection Against Wicked Clients/] Lucu is fragile against
---   wicked clients. No attacker should be able to cause a
+--   [/Protection Against Wicked Clients/] Lucu is somewhat fragile
+--   against wicked clients. No attacker should be able to cause a
 --   buffer-overflow but can possibly DoS it.
 --
 module Network.HTTP.Lucu
     ( -- * Entry Point
       runHttpd
 
-      -- * Configuration
+      -- * 'Config'uration
     , module Network.HTTP.Lucu.Config
 
       -- * Resource Tree
     , ResTree
     , mkResTree
 
-      -- * Resource Monad
+      -- * 'Resource' Monad
     , module Network.HTTP.Lucu.Resource
 
       -- ** Things to be used in the Resource monad
-
       -- *** Status Code
     , StatusCode(..)
 
@@ -68,18 +66,17 @@ module Network.HTTP.Lucu
     , mkMIMEType
     , parseMIMEType
 
-      -- *** Authorization
+      -- *** Authentication
     , AuthChallenge(..)
     , AuthCredential(..)
     
-      -- * Utility
-
+      -- * Utilities
       -- ** Static file handling
     , module Network.HTTP.Lucu.StaticFile
     )
     where
 import Network.HTTP.Lucu.Abortion
-import Network.HTTP.Lucu.Authorization
+import Network.HTTP.Lucu.Authentication
 import Network.HTTP.Lucu.Config
 import Network.HTTP.Lucu.ETag
 import Network.HTTP.Lucu.Httpd