Skip to content
This repository was archived by the owner on Mar 9, 2019. It is now read-only.

Commit 2c56b2a

Browse files
committed
Merge pull request #474 from elithrar/patch-1
[docs] Add table of contents
2 parents f115313 + d6ce6a9 commit 2c56b2a

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ and setting values. That's it.
1313
[hyc_symas]: https://twitter.com/hyc_symas
1414
[lmdb]: http://symas.com/mdb/
1515

16-
1716
## Project Status
1817

1918
Bolt is stable and the API is fixed. Full unit test coverage and randomized
@@ -22,6 +21,35 @@ Bolt is currently in high-load production environments serving databases as
2221
large as 1TB. Many companies such as Shopify and Heroku use Bolt-backed
2322
services every day.
2423

24+
## Table of Contents
25+
26+
- [Getting Started](#getting-started)
27+
- [Installing](#installing)
28+
- [Opening a database](#opening-a-database)
29+
- [Transactions](#transactions)
30+
- [Read-write transactions](#read-write-transactions)
31+
- [Read-only transactions](#read-only-transactions)
32+
- [Batch read-write transactions](#batch-read-write-transactions)
33+
- [Managing transactions manually](#managing-transactions-manually)
34+
- [Using buckets](#using-buckets)
35+
- [Using key/value pairs](#using-keyvalue-pairs)
36+
- [Autoincrementing integer for the bucket](#autoincrementing-integer-for-the-bucket)
37+
- [Iterating over keys](#iterating-over-keys)
38+
- [Prefix scans](#prefix-scans)
39+
- [Range scans](#range-scans)
40+
- [ForEach()](#foreach)
41+
- [Nested buckets](#nested-buckets)
42+
- [Database backups](#database-backups)
43+
- [Statistics](#statistics)
44+
- [Read-Only Mode](#read-only-mode)
45+
- [Resources](#resources)
46+
- [Comparison with other databases](#comparison-with-other-databases)
47+
- [Postgres, MySQL, & other relational databases](#postgres-mysql--other-relational-databases)
48+
- [LevelDB, RocksDB](#leveldb-rocksdb)
49+
- [LMDB](#lmdb)
50+
- [Caveats & Limitations](#caveats--limitations)
51+
- [Reading the Source](#reading-the-source)
52+
- [Other Projects Using Bolt](#other-projects-using-bolt)
2553

2654
## Getting Started
2755

0 commit comments

Comments
 (0)