* 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
* Add `libatomic1` as dependency for ubuntu install
* Move libatomic install instructions up and include `yum` instruction
* Add `dnf`, `apk` & `pacman` instructions for `libatomic` requirement
Mirrors the error when running `pear-cli` without `libatomic` installed.
* 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
* 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
* Clarify how `pear stage` generates key & replicates staged changes
* Clarify how `pear seed` distributes the channel / link of an app
* Add brief description of release pointer to `pear release` doc
* Add note about rolling back a release
* Fix grammar & add more details to why staging can propagate w/o seeding
* Tweak staging description to make update to version explicit
* Add second dump-based strategy for rolling back a release
Users should close resources like autopass in a teardown callback. In
this case it will speed up reruns as `pass.close()` calls hyperswarm's
`.destroy()` which will clean up the DHT records, speeding up joining on
rerun.
* 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
* Update `api.md` & `overview.md` w/ `bare`'s `README.md`
Adjusted to account for the extra modules section & the `api.md`
breaking out `Bare`'s API.
* Update `bare-module` docs w/ `bare-module`'s `README.md`
* Add `data` cli command & info about `apps` subcommand
* Add `pear reset` cli command for resetting a Pear application
Added a warning in the description as the command can result in lost
data and users should be cautious when using it.
* Remove leading spaces for `data` command flags
* Add note about dumping paths from `pear://` links in `dump` command
* Add `Pear.tray()` to Pear API docs
* Add supported formats for tray icon
* Remove `--unsafe-clear-preferences` from `pear run` cli doc
* Add `pear.gui.name` config option
* Edit new documentation for grammar & formatting
* Clarify `pear.gui.name` is an override & doesnt have a default
* Remove using "you" in `pear dump` doc & Correct grammar in `Pear.tray()`
Co-authored-by: David Mark Clements <huperekchunow@googlemail.com>
* Reword `pear reset` to make warning explicit
* Add note about hidden app issues when linux doesn't support `Pear.tray()`
---------
Co-authored-by: David Mark Clements <huperekchunow@googlemail.com>
* Add missing argument for `drive-writer-app` key in p2p fs howto
* Clarify where applications should be run in howtos
The wording is adjusted to make it clearer when one pear app should be
left running and where to run apps in general. In some cases a reader
would be prompted to make a directory and then change directories into
it and modify some files. After modifying the files, they would be asked
to change into the directory again even though they would be in the
directory already. This has been clarified by removing commands for
changing directory where the reader will be already in that directory.
* Add `pear.gui.hideable` configuration option
Added in Pear v1.10.0
* Add note about platform specific `gui` options
* Tweak platform list text to show connection w/ header
* Clean up line breaks in gui platform config section
* Remove platforms not supported by electron in GUI config section
* Add `Pear.badge(count)` documentation
Picked `null` to be the documented way to display a plain dot given it
coerces to `0`, so passes the `Number.isInteger(count)` check, and has
the same behavior in plain electron.
* Add `pear.stage.prefetch` to Application Configuration
* Update `stage` subcommand help output
The `truncate` was added since
https://github.com/holepunchto/pear/commit/85892a6a#diff-c218df6a550b0f3a42a2879e83f3ce2281061a1e79123d2a6d610d62d5f63bd8R79
but was missing.
* Add `pear.userAgent` to Application Configuration
* Adjust info about warmup in the guides
* Clarify that `pear.userAgent` will not change Sidecar requests
* Add `bare-expo` to "Bare on Mobile" w/ brief Pear-end explanation
* Add footnote about the term worklet to Bare on Mobile
* Add phrase about using RPC to communicate w/ worklet in Bare on Mobile
* Reword note about `bare-ios` & `bare-android` examples
* Remove `--` for app option passthrough
Changed since `paparam` was used for parsing command line options:
85892a6a32a84ae42a548f8e3ac0b5dbedd70c80
Now uses `cmd.rest` for app args.
* Use `Pear.config.args` for howto scripts
* Update "starting a pear desktop project" guide to match template
* Remove `--no-ask-trust` flag from `pear run` cli doc
This command was replaced by `--no-ask` which was already in the
documentation. Updated a reference to `--no-ask-trust` in the 'Sharing a
Pear Application' guide.
* Fix typos in "Releasing a Pear Application" guide
* Correct application storage folder name in hyperbee howto
* Add missing `test/index.test.js` in project structure for terminal guide
* Remove language about app continuing to run
This is no longer true at least as of pear:
v0.5114.pqbzjhqyonxprx8hghxexnmctw75mr91ewqw5dxe1zmntfyaddqy / v1.5.0
* Fix extra indention in example code for hypercore howto
* Format json in `_template.json` example
* Add instructions to set up a minimal `package.json` for testing template
Without this, the next step of `pear run --dev .` does not work since
`pear` expects a `package.json` file.
* Rename hyperbee reader app in hyperdrive howto to avoid name conflict
Naming only matters if someone is following the guides and starts each
guide from the same root directory. If they do, then `bee-reader-app`
from the hyperdrive conflicts with the `bee-reader-app` from the
hyperbee howto.
* Remove unrelated youtube tutorial from hyperswarm howto
* Update guide/creating-a-pear-init-template.md
Co-authored-by: David Mark Clements <huperekchunow@googlemail.com>
* Fix spelling mistake
Co-authored-by: David Mark Clements <huperekchunow@googlemail.com>
---------
Co-authored-by: David Mark Clements <huperekchunow@googlemail.com>
* Change `key` to `link` to match CLI functionality
CLI commands have changed to take the link format (`pear://<key>`)
instead of the key.
* Update guides to use `link` instead of `key` for CLI commands
Servers can be run on normal home computers, as the DHT will UDP holepunch connections are personal to users.
-->
"You can run servers on normal home computers, as the DHT will UDP holepunch connections for you."
