aljaz/pear-docs
1
0
Fork 0
mirror of https://github.com/aljazceru/pear-docs.git synced 2025-12-18 15:04:26 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #34 from PearTree-to/summaryfix

Browse Source 
Fixed SUMMARY.md, renamed README.md
This commit is contained in:
David Mark Clements
2024-02-14 01:06:05 +01:00
committed by GitHub
parent 3ae795b653 49005880a2
commit 9e21e3f403
2 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
summary.md → SUMMARY.md
View File

@@ -1,6 +1,6 @@
# Table of contents # Table of contents
* [Overview](./readme.md) * [Pear by Holepunch](./readme.md)
### Reference ### Reference
@@ -18,6 +18,15 @@
* [Sharing a Pear Application](./guide/sharing-a-pear-app.md) * [Sharing a Pear Application](./guide/sharing-a-pear-app.md)
* [Marking a Release](./guide/releasing-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 ## Building blocks
* [Hypercore](./building-blocks/hypercore.md) * [Hypercore](./building-blocks/hypercore.md)
@@ -28,15 +37,6 @@
* [Hyperswarm](./building-blocks/hyperswarm.md) * [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 ## Helpers
* [Corestore](./helpers/corestore.md) * [Corestore](./helpers/corestore.md)

2
readme.md
View File

@@ -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. * [`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. * [`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. * [`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. * [`protomux`](./helpers/protomux.md): Multiplex multiple message oriented protocols over a stream.
## Tools ## Tools