Commit Graph

394 Commits

Author SHA1 Message Date
Sean Zellmer
47c6f034cb Pear release 1.11.1 docs (#169)
* 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>
2025-03-07 12:54:57 -06:00
Marco
835fd15cb6 remove-redundant-replicate-corestore (#171) 2025-03-05 12:56:49 +01:00
Sean Zellmer
c8b7455f25 Clarify where to run apps in howtos (#170)
* 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.
2025-02-28 12:16:09 +01:00
Sean Zellmer
b011d81d27 Pear release 1.10.0 docs (#165)
* 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
2025-02-14 09:35:21 +01:00
Eric Bauerfeld
9713b381a1 Correct type description for encryptionKey option (#166) 2025-02-14 09:34:57 +01:00
Sean Zellmer
e2d6acccf0 Add Pear.media.getPathForFile(file) documentation (#164) 2025-01-17 12:42:27 +01:00
Sean Zellmer
f2f9cfeaa0 Clarify running Pear Runtime Desktop app (#163)
* Clarify how to open the Pear Runtime Desktop app

* Avoid double conjunction sentence in debugging guide
2025-01-13 00:28:35 +01:00
Sean Zellmer
02086fd150 Change RPC to IPC language in mobile bare docs (#159)
`bare-kit` API switched to just an IPC abstraction.
2024-12-23 10:00:49 +01:00
Sean Zellmer
dca7c8f3f8 Pear release 1.8.0 docs (#162)
* 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
2024-12-23 09:59:13 +01:00
rafapaezbas
299d287412 removed previewFor (#160) 2024-12-20 09:28:19 +01:00
rafapaezbas
10aee5aefb removed stage --bare flag (#161) 2024-12-20 09:27:29 +01:00
Sean Zellmer
cdc8606d96 Add bare-expo example & brief architecture explanation (#157)
* 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
2024-12-05 21:46:23 +01:00
Sean Zellmer
c6b63ae9fa Pear release 1.7.0 (#158)
* Remove `.getMediaSourceId()` documentation

Removed in: https://github.com/holepunchto/pear/pull/420

* Note that `Pear.restart()` & `Pear.reload()` is Desktop Only

* Revert "reverted dump dry-run flag"

This reverts commit 5eaee12d96.
2024-12-05 21:42:19 +01:00
rafapaezbas
5eaee12d96 reverted dump dry-run flag 2024-11-14 23:28:57 +01:00
Sean Zellmer
ac1349ee83 Doc updates for Pear release 1.6.0 (#155)
* Add dump dry-run flag

Added to pear with https://github.com/holepunchto/pear/pull/400/files

* Add `pear sidecar` logging flags

`-v` & `--sidecar` weren't added as they aren't used.

* Add `Pear.config.dht.nodes` & `Pear.config.dht.bootstrap`
2024-11-14 23:24:33 +01:00
Sean Zellmer
577c4c1bec Updating guides (1.5.0) (#154)
* 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>
2024-11-01 19:32:58 +01:00
Marco
1bebdf1a95 Fix typo on Pear.messages api (#153) 2024-10-28 22:01:27 +11:00
Sean Zellmer
c0956c273d Fix spelling mistakes (#150) 2024-10-22 15:07:06 +02:00
Sean Zellmer
b4ad921fde Add --force flag for dump CLI (#151) 2024-10-22 15:06:36 +02:00
Sean Zellmer
706f396a5d Convert all howtos to use pear run --dev (#152) 2024-10-22 15:06:18 +02:00
Sean Zellmer
174dcce808 Fix 'key' vs 'link' (#149)
* 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
2024-10-19 17:10:21 +02:00
Sean Zellmer
040acadf22 Add documentation for pear touch command (#147)
* Add documentation for `pear touch` command

* Add `pear seed <link>` example to `pear touch` doc
2024-10-16 09:18:48 +02:00
rafapaezbas
d9b340f00e remove Pear.preferences API (#146) 2024-10-15 18:47:40 +02:00
Sean Zellmer
ae3b4eeab1 Remove hidden --encryption-key flag (#148) 2024-10-15 18:18:39 +02:00
Vivek Singh
03fee03bba fix json 2024-10-15 11:55:04 +05:30
Vivek Singh
bb1a59a909 add .DS_Store to gitignore 2024-10-15 11:09:41 +05:30
Vivek Singh
2335c089ed fixes to nodejs compat 2024-10-15 11:03:37 +05:30
Vivek Singh
41c183df0a Add aliasing and import map examples (#144)
* add npm aliasing info for bare

* fix content and add import maps

* fixes
2024-10-11 18:37:46 +02:00
Vivek Singh
fc85e089fb Alignment for release v1.5 (#139)
* update and add flags for release

* add encryption flag
2024-10-11 12:14:55 +02:00
Vivek Singh
2ee7373e62 add pear interface (#143)
* add pear interface

* fix semi-colon spacing
2024-09-25 12:18:40 +02:00
Vivek Singh
15b52d79a5 Update api (#142)
* add missing config options

* remove pear dev references

* fix headings and typo
2024-09-25 09:17:19 +02:00
Vivek Singh
911cf1bda7 add guide to README and SUMMARY 2024-09-23 18:32:14 +05:30
Vivek Singh
655f425a5b guide for creating pear init templates (#141)
* first draft

* create guide draft

* add assets for guide

* remove __main__ file, add note

* fix quotes
2024-09-20 13:37:48 +02:00
Vivek Singh
200a55150e add draggable title bar info in guide (#140)
* update guide

* wrap pear-ctrl in titlebar

* adjusted mac pear-ctrl margin

---------

Co-authored-by: rafapaezbas <rafaelpaezbastida@gmail.com>
2024-09-17 18:11:30 +02:00
annadevile
ccb62402a8 Fix sentence hyperdht.md (#138)
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."
2024-09-13 10:58:54 +02:00
HDegroote
5da6fb2460 Don't mention hyperswarm in 2-peer example about HyperDHT (#137) 2024-09-13 10:46:59 +02:00
d61b292b-2859-4ed6-8c7c-b7397ad8e351
2d315baaa7 Update api.md (#136) 2024-09-13 10:26:51 +02:00
Jan Keith Darunday
6f5cd6c8ae Add documentation about http(s)://* whitelists (#135) 2024-08-27 14:50:35 +02:00
Vivek Singh
3817bff892 Update guides (#134)
* update desktop guide

* update pear terminal guides

* fixes

* fix ctrl-c for example terminal app

* use SIGINT on readline close

---------

Co-authored-by: rafapaezbas <rafaelpaezbastida@gmail.com>
2024-08-27 12:15:39 +02:00
Vivek Singh
ec51b8697a fix pear worker 2024-08-27 15:16:21 +05:30
Vivek Singh
4ae59c9621 add deprecation note to pear dev 2024-08-27 15:11:54 +05:30
rafapaezbas
01cf095103 Merge branch 'main' into live 2024-08-22 17:57:19 +02:00
Vivek Singh
884211abcb Release alignment (#133)
* update pear worker

* update pear dump

* update pear run

* update pear versions

* typo fix

* update pear wakeups

* fix

* fix pear versions

* fix cli
2024-08-22 14:14:14 +02:00
Vivek Singh
7d3d279059 simplify bare overview 2024-08-20 15:22:36 +05:30
d61b292b-2859-4ed6-8c7c-b7397ad8e351
b11083fc8d Fix typo (#130) 2024-08-20 14:18:50 +05:30
rafapaezbas
74a3e1a3f6 fix pear worker docs (#129) 2024-08-15 19:12:03 +02:00
d61b292b-2859-4ed6-8c7c-b7397ad8e351
928bb27b3e Fix dependencies (#128)
Add `hyperbee` to installed packages

Remove `debounceify` since it's not used
2024-08-15 14:18:53 +02:00
d61b292b-2859-4ed6-8c7c-b7397ad8e351
6b7ca689cb Fix URL fragment (#127)
Link to join method was broken
2024-08-14 13:13:54 +02:00
Vivek Singh
1a4f97138f fixes (#126) 2024-08-14 10:39:34 +02:00
Md Tanjin Alam
e28cf00b10 Fixed command-line argument parameter parsing across files from process.argv[2] to process.argv[3] (#115) 2024-08-14 09:52:15 +02:00