From a176a88b8cfc71e36071488bcdd570f7549bf461 Mon Sep 17 00:00:00 2001 From: Ladd Date: Tue, 24 Dec 2024 13:58:02 -0600 Subject: [PATCH] added concept status info to README --- README.md | 20 ++++++++++++++++---- src/http-api.ts | 4 +++- 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d792796..5ab7877 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ +# Concepts + +| | Implemented | Notes | +| ------- | ----------- | ----- | +| Peering | Yes | Currently using RHIZOME_SEED_PEERS, no gossip / discovery | +| Schemas | Not really | Currently very thin layer allowing TypedCollections | +| Relationships | No | Supporting relational algebra among domain entities | +| Views | Yes | Currently using functions rather than JSON-Logic expressions | +| Functions | No | Arbitrary subscribers to delta stream (that can also emit deltas?) | +| Tests | Minimal | So far we have a few `ts-jest` tests. Need a plan for multi-node tests. | +| Identity | No | Probably a public key / private key system | +| Contexts | No | Each context may involve different lossy functions and delta filters | +| HTTP API | Yes | Basic peering info and entity CRUD | + +# Development / Demo + ## Setup Install [`nvm`](https://nvm.sh) @@ -87,7 +103,3 @@ Query the list of deltas ingested by this node curl -s http://localhost:3000/deltas | jq ``` -# Project Management - -- [] Item 1 -- [] Item 2 diff --git a/src/http-api.ts b/src/http-api.ts index 15ee4bd..377842d 100644 --- a/src/http-api.ts +++ b/src/http-api.ts @@ -15,8 +15,10 @@ type CollectionsToServe = { }; const docConverter = new Converter({ + completeHTMLDocument: true, simpleLineBreaks: true, - completeHTMLDocument: true + tables: true, + tasklists: true }); const htmlDocFromMarkdown = (md: string): string => docConverter.makeHtml(md);