webcit-ng

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

diff --git a/webcit-ng/README.txt b/webcit-ng/README.txt
new file mode 100644 (file)
index 0000000..82c0a93
--- /dev/null
+++ b/webcit-ng/README.txt
@@ -0,0 +1,31 @@
+
+
+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.
+
+Please don't mess with this yet.  I'm only pushing it upstream so it gets
+backed up.
+
+
+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.
+
+*      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 URIs will generally take the form of:
+
+       /ctdl/objectClass/[container/]object[/operation]
+