aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2018-05-16 18:41:54 -0700
committerBryan Newbold <bnewbold@robocracy.org>2018-05-16 18:41:54 -0700
commita06721491227266e8abc829a754dfed1a84deec7 (patch)
treea2d160941e3b4b3abaf95602838b620862400eb3 /README.md
parent4cf667c283d54f769e73d76bb23bbb68b4329cf8 (diff)
downloadfatcat-a06721491227266e8abc829a754dfed1a84deec7.tar.gz
fatcat-a06721491227266e8abc829a754dfed1a84deec7.zip
update README
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).