summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..9d2a754c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+
+ __ _ _
+ / _| __ _| |_ ___ __ _| |_
+ | |_ / _` | __/ __/ _` | __|
+ | _| (_| | || (_| (_| | |_
+ |_| \__,_|\__\___\__,_|\__|
+
+ ... catalog all the things!
+
+
+The [RFC](./rfc) is the original design document, and the best place to start
+for background.
+
+There will be three main components:
+
+- backend API server and database
+- front-end web interface (built on API)
+- client libraries and bots
+
+The API server was prototyped in python. "Real" implementation started in
+golang, but shifted to Rust, and is work-in-progress. The beginings of a client
+library and data ingesters exist in python (may or may not be re-written in
+Rust).