From 87a48a66b28e4cfb53df86776ccce871aa9b0f68 Mon Sep 17 00:00:00 2001 From: Art Cancro Date: Sat, 10 Sep 2022 20:13:44 -0400 Subject: [PATCH] README.txt is now README.md because why not. Also included an obnoxious comment about how we're not going to use your favorite CSS or JS library because everything is lovingly hand coded and Citadel components tend to outlive web libraries. --- webcit-ng/{README.txt => README.md} | 22 +++++++--------------- 1 file changed, 7 insertions(+), 15 deletions(-) rename webcit-ng/{README.txt => README.md} (90%) diff --git a/webcit-ng/README.txt b/webcit-ng/README.md similarity index 90% rename from webcit-ng/README.txt rename to webcit-ng/README.md index ee5f5f363..07910d8e7 100644 --- a/webcit-ng/README.txt +++ b/webcit-ng/README.md @@ -1,4 +1,4 @@ - +# 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 @@ -9,32 +9,24 @@ Please don't mess with this yet. I'm only pushing it upstream so it gets backed 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. - -DESIGN GOALS ------------- - +## 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. - - - REST format URLs will generally take the form of: /ctdl/objectClass/[container/]object[/operation] -We are using ------------- - +## We are using * libcitadel for information about the Citadel server, some string handling, and the JSON encoder * Expat for DAV handling * OpenSSL for TLS + +## We are NOT using +* Your favorite javascript library +* Your favorite CSS framework -- 2.39.2