Commit Graph

39 Commits

Author SHA1 Message Date
Sean Zellmer
c966f41503 Remove --seeders flag from pear seed doc (#179)
Removed here: https://github.com/holepunchto/pear/pull/655/files
2025-03-27 18:57:03 +01:00
Sean Zellmer
08caadb392 Update how development mode affects Pear config API (#177) 2025-03-20 19:38:09 +01:00
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
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
Sean Zellmer
e2d6acccf0 Add Pear.media.getPathForFile(file) documentation (#164) 2025-01-17 12:42:27 +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
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
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
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
15b52d79a5 Update api (#142)
* add missing config options

* remove pear dev references

* fix headings and typo
2024-09-25 09:17:19 +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
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
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
rafapaezbas
74a3e1a3f6 fix pear worker docs (#129) 2024-08-15 19:12:03 +02:00
Vivek Singh
ad3f757d8d update pear-init (#121) 2024-08-05 15:37:50 +02:00
Vivek
9990a5fd30 add more context to pear.links 2024-07-25 18:17:42 +05:30
Vivek Singh
822978d2ab fixes and add more context to pear links (#117) 2024-07-19 13:02:14 +02:00
Vivek Singh
33984fb272 add-missing-flags (#116) 2024-07-04 12:48:01 +02:00
Vivek Singh
497a98ce96 add pear gc (#114)
* add pear gc

* fixes
2024-06-12 11:29:04 +02:00
Vivek Singh
f33dd39a53 add pear worker (#113)
* add pear worker

* fixes
2024-06-12 10:35:35 +02:00
Vivek Singh
597700548c add previewFor (#111)
Co-authored-by: Vivek Singh <vivek@peartree.to>
2024-06-04 10:13:30 +02:00
Vivek Singh
61da1fed26 add pear exit (#107) 2024-05-09 14:49:23 +02:00
Vivek Singh
33dd6e8c8b remove pear repl (#103)
Co-authored-by: Vivek Singh <vivek@peartree.to>
2024-04-26 12:18:35 +02:00
Vivek Singh
c4c9746a8e update pear info (#99)
Co-authored-by: Vivek Singh <vivek@peartree.to>
2024-04-16 10:47:56 +02:00
Vivek Singh
52020bb370 add pear shift to cli (#98)
* add pear shift to cli

* add backticks to cmds in cli

---------

Co-authored-by: Vivek Singh <vivek@peartree.to>
2024-04-15 10:20:19 +02:00
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