Files
pear-docs/SUMMARY.md
rafapaezbas 543b19ad1e Add bare reference to docs (#88) (#91)
* add files in bare ref

* update SUMMARY to contain bare ref

* update README to point to bare ref

* typo fix

* move modules section

* add intro to API

* tiny fix

* add intro to bare modules

* add description to cond exports

* remove api section from bare modules

---------

Co-authored-by: Vivek Singh <47470314+heyitsvi@users.noreply.github.com>
Co-authored-by: Vivek Singh <vi@localhost.localdomain>
Co-authored-by: Vivek Singh <vivek@peartree.to>
2024-03-13 17:28:18 +01:00

71 lines
2.5 KiB
Markdown

# Table of contents
* [Pear by Holepunch](./README.md)
### Pear runtime
* [Command-Line-Interface (CLI)](./reference/cli.md)
* [Application-Programming-Interface (API)](./reference/api.md)
* [Application Configuration](./reference/configuration.md)
### Bare reference
* [Overview](./bare-reference/overview.md)
* [Application-Programming-Interface (API)](./bare-reference/api.md)
* [Node.js Compatibility with Bare](./bare-reference/nodejs-compatibility-with-bare.md)
* [Bare Modules](./bare-reference/bare-modules.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)
* [Debugging a Pear Terminal Application](./guide/debugging-a-pear-terminal-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)
### 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
* [Cross-platform Pear App](examples/cross-platform-pear-app.md)
* [Bare on Mobile](examples/bare-on-mobile.md)
* [React App using Pear](examples/react-app-using-pear.md)