From 75cb3391e8710ece92586f6d2197c4cd5cc909c8 Mon Sep 17 00:00:00 2001 From: Aditya Mukhopadhyay Date: Mon, 3 Jul 2023 11:47:25 +0530 Subject: [PATCH] Updated README.md. --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 095d3f5..19455d4 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,28 @@ # minigraf -A tiny, portable GraphQL engine. +A tiny, portable GraphQL engine. **W.I.P.** + +## Purpose +This project was started to (in order): +- Learn Rust, +- Learn how to write a parser, +- Learn GraphQL, +- Possibly create a borderline useful tool in the process. + +## Scope +Minigraf will be designed to run in multiple environments, including: +- As a standalone binary, +- As a library, +- As a WebAssembly module (for browsers). + +## Anti-Scope +Mingraf will **NOT** be designed to be (for now): +- Distributed, +- Fault-tolerant, +- ACID-compliant. + +## Features +Minigraf will support multiple backends to store its data, including: +- In-memory, +- IndexedDB (browser only), +- SQLite, +- One of more embedded KV stores (such as LevelDB or RocksDB).