Commit Graph

15 Commits

Author SHA1 Message Date
Sean Zellmer
b11bb658c7 Add Best practices article (#186)
* 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
2025-05-31 01:01:23 -05:00
Sean Zellmer
72b0d04f36 FAQs (#187)
* Add preliminary FAQs on developing Pear applications

* Emphasize that NPM is great

* Add information about where data & applications are stored

* Clarify Pear storage FAQ & add links to references

* Add FAQ for IP address exposure

* Reword where how to get `pearDir`

* Fix links in FAQs

* Fix `pear dump` link in FAQ

* Reorder storage FAQ after listing & reseting apps

Places questions for users of Pear applications higher.

* Fix unnecessary capitalization

* Clean up table markdown in FAQ

* Add non-alias example to `pear data apps` example output in FAQ

* Note why NPM is used as the pkg manager & whether its required for Pear

* Add FAQs to README.md & SUMMARY.md
2025-05-29 15:26:29 -05:00
Sean Zellmer
a35091a267 Troubleshooting docs for Pear & Bare (#184)
* Add Troubleshooting guide stub w/ info on Pear.teardown & worker hang

* Add troubleshooting steps for debugging Pear app exiting silently

* Add troubleshoot entry on debugging `Error: While lock file...`

* Add troubleshooting entry on debugging slow hyperswarm joins

* Add entry for debugging running Bare modules in Pear desktop

* Add troubleshooting stub for Bare w/ info on bare vs node modules

* Add debugging guide for `bare-pack` w/ dynamic conditional imports

* Fix Node.js spelling & module -> package typo

* Link to 'nodejs compatibility' alias section in Bare troubleshooting

* Fix missing extension in link

* Add entry for debugging `ADDON_NOT_FOUND`

* Fix typo in troubleshooting guide for bare

* Add links to troubleshooting articles in SUMMARY.md & README.md

* Update Pear troubleshooting article title

* Refine reasons for joining Hyperswarm topics & fix minor formatting

* Clarify that aliases are for Bare support & dont prevent Node.js support

* Rework aliases description

Now it's clearer that its to add support and doesn't modify the
dependencies.

* Remove unnecessary `-d` in Pear troubleshooting guide
2025-05-15 13:29:45 -05:00
Sean Zellmer
5800a7031f Add Mobile Application Guide (#167)
* Add "Making a Bare Mobile App" guide

* Change title to be 'Application' instead of 'App' in mobile guide

* Pin `autopass` to `1.x.x` in mobile guide

* Update "Bare on Mobile" to point readers to the mobile guide

* Add Bare mobile application guide to README.md

* Tweak wording in "Bare on Mobile"

* Remove "Cross-platform Pear App" example

This example app has been archived and is now outdated.

* Add missing link in SUMMARY.md for mobile guide

* Update mobile app guide to use new worklet api & support autopass@2.1
2025-03-18 08:54:42 +01:00
Vivek Singh
911cf1bda7 add guide to README and SUMMARY 2024-09-23 18:32:14 +05:30
Vivek Singh
b339e2878a move bare ref and update links (#93)
* move bare ref and update links

* move pear ref into subfolder

* update README

* tiny fix

---------

Co-authored-by: Vivek Singh <vivek@peartree.to>
2024-03-21 14:13:04 +01:00
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
Subash SN
742a10090e Added note on Bare runtime + cross platform app example (#62)
* Added Bare ref, expanded examples

* Added cross platform mobile app

* Improved Bare

* mc

* mc

* mc
2024-02-21 14:16:19 +01:00
Subash SN
0858941ae1 Added examples (#61) 2024-02-21 10:14:37 +01:00
Subash SN
dd1bc41fc7 Added Keet + trimmed down README.md (#59)
* added Keet + structural changes

* Fixed headings

* Updated README.md

* Removed tables

* Fix syntax

---------

Co-authored-by: Subash <subash@vuln.in>
2024-02-20 16:15:36 +01:00
rafapaezbas
ddc68c0199 removed duplicated readme.md (#58)
* removed duplicated readme.md

* replace readme.md with README.md

---------

Co-authored-by: rafapaezbas <rafa@holepunch.com>
2024-02-20 13:55:17 +01:00
Tobias Baunbæk Christensen
af9d543015 Add guide on terminal debugging (#43)
* Add guides on how to debug mobile/terminal apps

* Rename to Pear Desktop

* Cleanup

* Clean Pear.config.args explanation

* Fix incorrect renaming

* Remove mobile debugging guide

* Rename fix

* Rename back to Pear Runtime
2024-02-16 15:35:02 +01:00
Ubuntu
ff19427d02 Removed gitbook config 2024-02-13 14:27:51 +00:00
Ubuntu
96d5b8577b Added gitbook config 2024-02-13 13:35:43 +00:00
Ubuntu
e201907129 Fixed SUMMARY.md, renamed README.md 2024-02-13 11:36:10 +00:00