From 14b1ae5af20b5324f363ed8d1345911047d7d1e4 Mon Sep 17 00:00:00 2001 From: Aaron Boodman Date: Wed, 20 Sep 2017 23:39:29 -0700 Subject: [PATCH] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 57b5dbbeed..c14c95e226 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ -[Technical Overview](doc/intro.md)  |  [Use Cases](doc/uses.md)  |  [FAQ](doc/faq.md)  |  [Command-Line Interface](doc/cli-tour.md)  |  [Go SDK](doc/go-tour.md)  |  [Path Syntax](doc/spelling.md) +[Use Cases](doc/uses.md)  |  [Setup](#setup)  |  [Status](#status)  |  [Documentation](./docs)  |  [Contact](#contact)

[![Build Status](http://jenkins3.noms.io/buildStatus/icon?job=NomsMasterBuilder)](http://jenkins3.noms.io/job/NomsMasterBuilder/) [![codecov](https://codecov.io/gh/attic-labs/noms/branch/master/graph/badge.svg)](https://codecov.io/gh/attic-labs/noms) [![GoDoc](https://godoc.org/github.com/attic-labs/noms?status.svg)](https://godoc.org/github.com/attic-labs/noms) [![Slack](http://slack.noms.io/badge.svg)](http://slack.noms.io) +# Welcome + *Noms* is a decentralized database philosophically descendant from the Git version control system. Like Git, Noms is: @@ -17,7 +19,7 @@ Like Git, Noms is: Unlike Git, Noms is a database, so it also: * Primarily **stores structured data**, not files and directories (see: [the Noms type system](https://github.com/attic-labs/noms/blob/master/doc/intro.md#types)) -* **Scales well** to large amounts of data and concurrent clients (TODO: benchmarks) +* **Scales well** to large amounts of data and concurrent clients * Supports **atomic transactions** (a single instance of Noms is CP, but Noms is typically run in production backed by S3, in which case it is "[effectively CA](https://cloud.google.com/spanner/docs/whitepapers/SpannerAndCap.pdf)") * Supports **efficient indexes** (see: [Noms prolly-trees](https://github.com/attic-labs/noms/blob/master/doc/intro.md#prolly-trees-probabilistic-b-trees)) * Features a **flexible query model** (see: [GraphQL](./go/ngql/README.md))