Remove preprocessor tests for OpenSSL. It's a requirement.

[citadel.git] / webcit-ng / README.md

diff --git a/webcit-ng/README.md b/webcit-ng/README.md
index 07910d8e79c6b05cee6133962d62421aef32a664..bcae8a78b5b4ed37b30f89834254a1f9fedb4080 100644 (file)
--- a/webcit-ng/README.md
+++ b/webcit-ng/README.md
@@ -1,32 +1,30 @@
 # WebCit-NG
 
 This is WebCit-NG, a complete refactoring of the WebCit server that will
-focus on "REST first" and build around that.  The code will be well
-layered with as little spaghetti as possible.
+focus on "REST first" and build around that.  The server code is well layered
+with as little spaghetti as possible.
 
-Please don't mess with this yet.  I'm only pushing it upstream so it gets backed up.
-
-Yes, I know the Makefile is built in a way that forces it to recompile everything
-when you touch even one file.  For the time being this is acceptable.
+This is a work in progress and not ready for production use.  It is not feature
+complete.
 
 ## Design goals
-*      Hold as little state as possible
-*      Require NO cleanup.   Killing the process lets the OS reclaim all resources.
-*      As much as possible, resources should be freed by just coming back down the stack.
-       Avoid global variables and thread-local variables as much as possible.
-*      Readability of the code is more important than shaving off a few CPU cycles.
-*      Throw sensitive data such as passwords back and forth in clear text.
-       If you want privacy, encrypt the whole session.  Anything else is false security.
+* Hold as little state as possible
+* Require NO cleanup.  Killing the process lets the OS reclaim all resources.
+* As much as possible, resources should be freed by just coming back down the
+  stack.  Avoid global variables and thread-local variables as much as possible.
+* Readability of the code is more important than shaving off a few CPU cycles.
+* Throw sensitive data such as passwords back and forth in clear text.  If you
+  want privacy, encrypt the whole session.  Anything else is false security.
 
 REST format URLs will generally take the form of:
 
-       /ctdl/objectClass/[container/]object[/operation]
+  /ctdl/objectClass/[container/]object[/operation]
 
 ## We are using
-*      libcitadel for information about the Citadel server, some string handling, and the JSON encoder
-*      Expat for DAV handling
-*      OpenSSL for TLS
+* libcitadel for Citadel server tooling, string handling, JSON encoder, MIME parser
+* Expat for DAV handling
+* OpenSSL for TLS
+* FontAwesome for icons
 
 ## We are NOT using
-* Your favorite javascript library
-* Your favorite CSS framework
+* Third party javascript libraries and/or CSS frameworks