mirror of
https://github.com/aljazceru/pear-docs.git
synced 2025-12-18 15:04:26 +01:00
b11bb658c7
* Add aside about using only one corestore instance per application A single corestore instance covers all needs and avoids pitfalls (such as file locks and named hypercores not being the same key) that come from multiple corestore instances. * Add note for best practice to create one hyperswarm instance per app * Create a best practices guide for Pear Application development * Add "Best Practices" article to SUMMARY.md & README.md * Include points added to the guides on using single swarm & store * Fix capitalization in Best Practices article
77 lines
2.8 KiB
Markdown
77 lines
2.8 KiB
Markdown
# Table of contents
|
|
|
|
* [Pear by Holepunch](./README.md)
|
|
|
|
### Pear runtime
|
|
|
|
* [Command-Line-Interface (CLI)](./reference/pear/cli.md)
|
|
* [Application-Programming-Interface (API)](./reference/pear/api.md)
|
|
* [Application Configuration](./reference/pear/configuration.md)
|
|
* [Troubleshooting Applications](./reference/pear/troubleshooting.md)
|
|
* [Frequently Asked Questions](./reference/pear/faq.md)
|
|
|
|
### Bare reference
|
|
* [Overview](./reference/bare/overview.md)
|
|
* [Application-Programming-Interface (API)](./reference/bare/api.md)
|
|
* [Node.js Compatibility with Bare](./reference/bare/nodejs-compatibility-with-bare.md)
|
|
* [Bare Modules](./reference/bare/bare-modules.md)
|
|
* [Troubleshooting with Bare](./reference/bare/troubleshooting.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)
|
|
* [Making a Bare Mobile Application](./guide/making-a-bare-mobile-app.md)
|
|
* [Debugging a Pear Terminal Application](./guide/debugging-a-pear-terminal-app.md)
|
|
* [Creating a Pear Init Template](./guide/creating-a-pear-init-template.md)
|
|
* [Best Practices](./guide/best-practices.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)
|
|
|
|
### 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)
|
|
|
|
### Tools
|
|
|
|
* [Hypershell](tools/hypershell.md)
|
|
* [Hypertele](tools/hypertele.md)
|
|
* [Hyperbeam](tools/hyperbeam.md)
|
|
* [Hyperssh](tools/hyperssh.md)
|
|
* [Drives](tools/drives.md)
|
|
|
|
### Apps
|
|
|
|
* [Keet](apps/keet.md)
|
|
|
|
### Examples
|
|
|
|
* [Bare on Mobile](examples/bare-on-mobile.md)
|
|
* [React App using Pear](examples/react-app-using-pear.md)
|