* 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.
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
* 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
* 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
* on click, do not add route if included in pathname
* corrected readme tools table links
* remove code blocks inside links
* corrected hypercore and hyperwarm links
---------
Co-authored-by: rafapaezbas <rafa@holepunch.com>
