From 75b5dd084bd0ddcd7361d7076458bfd53d48891e Mon Sep 17 00:00:00 2001 From: Tpt Date: Fri, 28 Jan 2022 21:38:49 +0100 Subject: [PATCH] Adds a link to the design document --- README.md | 4 +++- lib/README.md | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 48831f97..e5a51224 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,9 @@ Its goal is to provide a compliant, safe, and fast graph database based on the [ It is written in Rust. It also provides a set of utility functions for reading, writing, and processing RDF files. -Oxigraph is in heavy development and SPARQL query evaluation has not been optimized yet. The development roadmap is using [GitHub milestones](https://github.com/oxigraph/oxigraph/milestones?direction=desc&sort=completeness&state=open). +Oxigraph is in heavy development and SPARQL query evaluation has not been optimized yet. +The development roadmap is using [GitHub milestones](https://github.com/oxigraph/oxigraph/milestones?direction=desc&sort=completeness&state=open). +Oxigraph internal design [is described on the wiki](https://github.com/oxigraph/oxigraph/wiki/Architecture). It is split into multiple parts: * [The database written as a Rust library](https://crates.io/crates/oxigraph). Its source code is in the `lib` directory. diff --git a/lib/README.md b/lib/README.md index 8d3064ed..1c1786f9 100644 --- a/lib/README.md +++ b/lib/README.md @@ -24,7 +24,7 @@ Oxigraph implements the following specifications: * [Turtle](https://www.w3.org/TR/turtle/), [TriG](https://www.w3.org/TR/trig/), [N-Triples](https://www.w3.org/TR/n-triples/), [N-Quads](https://www.w3.org/TR/n-quads/), and [RDF XML](https://www.w3.org/TR/rdf-syntax-grammar/) RDF serialization formats for both data ingestion and retrieval using the [Rio library](https://github.com/oxigraph/rio). * [SPARQL Query Results XML Format](http://www.w3.org/TR/rdf-sparql-XMLres/), [SPARQL 1.1 Query Results JSON Format](https://www.w3.org/TR/sparql11-results-json/) and [SPARQL 1.1 Query Results CSV and TSV Formats](https://www.w3.org/TR/sparql11-results-csv-tsv/). -A preliminary benchmark [is provided](../bench/README.md). +A preliminary benchmark [is provided](../bench/README.md). Oxigraph internal design [is described on the wiki](https://github.com/oxigraph/oxigraph/wiki/Architecture). The main entry point of Oxigraph is the [`Store`](store::Store) struct: ```rust