diff --git a/readme.md b/readme.md index 46d6121..e168b8d 100644 --- a/readme.md +++ b/readme.md @@ -14,7 +14,7 @@ Welcome to the Internet of Peers ## Table of Contents -### References +### Reference * [Command-Line-Interface (CLI)](./reference/cli.md) * [Application-Programming-Interface (API)](./reference/api.md) diff --git a/summary.md b/summary.md index 2752cd5..7638662 100644 --- a/summary.md +++ b/summary.md @@ -2,45 +2,49 @@ * [Overview](./readme.md) -## Pear +### Reference -* [Command Line Interface (CLI)](./pear/cli.md) -* [Application Programming Interface (API)](./pear/api.md) -* [Configuration](./pear/config.md) +* [Command-Line-Interface (CLI)](./reference/cli.md) +* [Application-Programming-Interface (API)](./reference/api.md) +* [Application Configuration](./reference/configuration.md) + +### Guides + +* [Getting Started](./guide/getting-started.md) +* [Starting a Pear Desktop Project](./guide/starting-a-pear-desktop-project.md) +* [Making a Pear Desktop Application](./guide/making-a-pear-desktop-app.md) +* [Starting a Pear Terminal Project](./guide/starting-a-pear-terminal-project.md) +* [Making a Pear Terminal Application](./guide/making-a-pear-terminal-app.md) +* [Sharing a Pear Application](./guide/sharing-a-pear-app.md) +* [Marking a Release](./guide/releasing-a-pear-app.md) ## Building blocks -* [Hypercore](building-blocks/hypercore.md) -* [Hyperbee](building-blocks/hyperbee.md) -* [Hyperdrive](building-blocks/hyperdrive.md) -* [Autobase](building-blocks/autobase.md) -* [HyperDHT](building-blocks/hyperdht.md) -* [Hyperswarm](building-blocks/hyperswarm.md) +* [Hypercore](./building-blocks/hypercore.md) +* [Hyperbee](./building-blocks/hyperbee.md) +* [Hyperdrive](./building-blocks/hyperdrive.md) +* [Autobase](./building-blocks/autobase.md) +* [HyperDHT](./building-blocks/hyperdht.md) +* [Hyperswarm](./building-blocks/hyperswarm.md) -## Guide -* [Connecting two peers](./guide/connecting-two-peers.md) -* [Connecting many peers](./guide/connecting-many-peers.md) -* [Hypercore: The Basics](./guide/hypercore.md) -* [Working with Many Hypercores](./guide/corestore.md) -* [Sharing Append-Only Databases](./guide/hyperbee.md) -* [A Full P2P Filesystem](./guide/hyperdrive.md) -* [Getting Started with Pear](./guide/getting-started.md) -* [Making a Pear Desktop App](./guide/making-a-pear-desktop-app.md) -* [Making a Pear Terminal Application](./guide/making-a-pear-desktop-app.md) -* [Releasing a Pear Application](./guide/releasing-a-pear-app.md) -* [Sharing a Pear Application](./guide/sharing-a-pear-app.md) -* [Personal Keet p2p chat Relay](./guide/personal-keet-p2p-chat-relay.md) -* [Terminology](./guide/terminology.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) -* [Localdrive](helpers/localdrive.md) -* [Mirrordrive](helpers/mirrordrive.md) -* [Secretstream](helpers/secretstream.md) -* [Compact encoding](helpers/compact-encoding.md) -* [Protomux](helpers/protomux.md) +* [Corestore](./helpers/corestore.md) +* [Localdrive](./helpers/localdrive.md) +* [Mirrordrive](./helpers/mirrordrive.md) +* [Secretstream](./helpers/secretstream.md) +* [Compact encoding](./helpers/compact-encoding.md) +* [Protomux](./helpers/protomux.md) ## Tools @@ -50,8 +54,4 @@ * [Hyperssh](tools/hyperssh.md) * [Drives](tools/drives.md) -## Apps - -* [Keet.io](apps/keet.io.md) -