diff --git a/summary.md b/SUMMARY.md similarity index 98% rename from summary.md rename to SUMMARY.md index 7638662..678621d 100644 --- a/summary.md +++ b/SUMMARY.md @@ -1,6 +1,6 @@ # Table of contents -* [Overview](./readme.md) +* [Pear by Holepunch](./readme.md) ### Reference @@ -18,6 +18,15 @@ * [Sharing a Pear Application](./guide/sharing-a-pear-app.md) * [Marking a Release](./guide/releasing-a-pear-app.md) +### How-tos + +* [Connect two peers](./howto/connect-two-peers-by-key-with-hyperdht.md) +* [Connect many peers](./howto/connect-to-many-peers-by-topic-with-hyperswarm.md) +* [Replicate & persist](./howto/replicate-and-persist-with-hypercore.md) +* [Manage multiple Hypercores](./howto/work-with-many-hypercores-using-corestore.md) +* [Share append-only databases](./howto/share-append-only-databases-with-hyperbee.md) +* [Create a p2p filesystem](./howto/create-a-full-peer-to-peer-filesystem-with-hyperdrive.md) + ## Building blocks * [Hypercore](./building-blocks/hypercore.md) @@ -28,15 +37,6 @@ * [Hyperswarm](./building-blocks/hyperswarm.md) -### How-tos - -* [Connect two peers](./howto/connect-two-peers-by-key-with-hyperdht.md) -* [Connect many peers](./howto/connect-to-many-peers-by-topic-with-hyperswarm.md) -* [Replicate & persist](./howto/replicate-and-persist-with-hypercore.md) -* [Manage multiple Hypercores](./howto/work-with-many-hypercores-using-corestore.md) -* [Share append-only databases](./howto/share-append-only-databases-with-hyperbee.md) -* [Create a p2p filesystem](./howto/create-a-full-peer-to-peer-filesystem-with-hyperdrive.md) - ## Helpers * [Corestore](./helpers/corestore.md) diff --git a/readme.md b/readme.md index 29705ff..967af81 100644 --- a/readme.md +++ b/readme.md @@ -105,7 +105,7 @@ Helper modules can be used together with the building blocks to create cutting-e * [`localdrive`](./helpers/localdrive.md): A file system interoperable with Hyperdrive. * [`mirrordrive`](./helpers/mirrordrive.md): Mirror a [`hyperdrive`](./building-blocks/hyperdrive.md) or a [`localdrive`](./helpers/localdrive.md) into another one. * [`secretstream`](./helpers/secretstream.md): SecretStream is used to securely create connections between two peers in Hyperswarm. -* [compact-`encoding`](./helpers/compact-encoding.md): A series of binary encoding schemes for building fast and small parsers and serializers. We use this in Keet to store chat messages and in Hypercore's replication protocol. +* [`compact-encoding`](./helpers/compact-encoding.md): A series of binary encoding schemes for building fast and small parsers and serializers. We use this in Keet to store chat messages and in Hypercore's replication protocol. * [`protomux`](./helpers/protomux.md): Multiplex multiple message oriented protocols over a stream. ## Tools