added concept status info to README
This commit is contained in:
parent
b7921a6edf
commit
a176a88b8c
20
README.md
20
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
|
## Setup
|
||||||
|
|
||||||
Install [`nvm`](https://nvm.sh)
|
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
|
curl -s http://localhost:3000/deltas | jq
|
||||||
```
|
```
|
||||||
|
|
||||||
# Project Management
|
|
||||||
|
|
||||||
- [] Item 1
|
|
||||||
- [] Item 2
|
|
||||||
|
|
|
@ -15,8 +15,10 @@ type CollectionsToServe = {
|
||||||
};
|
};
|
||||||
|
|
||||||
const docConverter = new Converter({
|
const docConverter = new Converter({
|
||||||
|
completeHTMLDocument: true,
|
||||||
simpleLineBreaks: true,
|
simpleLineBreaks: true,
|
||||||
completeHTMLDocument: true
|
tables: true,
|
||||||
|
tasklists: true
|
||||||
});
|
});
|
||||||
const htmlDocFromMarkdown = (md: string): string => docConverter.makeHtml(md);
|
const htmlDocFromMarkdown = (md: string): string => docConverter.makeHtml(md);
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue