Commit Graph

21 Commits

Author SHA1 Message Date
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
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
Sean Zellmer
c0956c273d Fix spelling mistakes (#150) 2024-10-22 15:07:06 +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
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
9ebb687611 add trust dialog info (#102)
* add trust dialog info

* fixes

* fix warning note
2024-04-23 12:37:38 +02:00
dazl
f1b3f1cb62 typos eg help stage vs stage help (#56)
Co-authored-by: dazl <dazl@dazl.ca>
2024-02-19 16:21:59 +01:00
Vivek Singh
fac1f73572 Fix grammar in docs (#49)
* fix grammar in readme

* fix grammar in compact-encoding

* fix grammar in hyperdht

* fix grammar in hyperdrive

* fix grammar in hypercore

* fix grammar in hyperswarm

* fix grammar in localdrive

* fix grammar in mirrordrive

* fix grammar in sharing-a-pear-app

* tiny fixes
2024-02-16 14:46:16 +01:00
Subash SN
a4d631e047 Embed syntax (#47)
Co-authored-by: Subash <subash@vuln.in>
2024-02-14 18:13:31 +01:00
Subash SN
837056a50e Updated Youtube links with existing markdown syntax (#40)
* Fixed youtube links

* Updated E2
2024-02-14 14:45:56 +01:00
rafapaezbas
636b931276 Fix router (#39)
* 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>
2024-02-14 14:11:39 +01:00
dmc
696fec2b86 videos 2024-02-12 18:40:22 +01:00
dmc
87198720b2 releasing a pear, readme iterate, howtos 2024-01-25 14:36:02 +01:00
dmc
8693b63c5c sharing an app + other improvements 2024-01-23 14:44:50 +01:00
dmc
c8e9868205 ordering/discussion 2024-01-11 14:48:12 +01:00
dmc
9785189c9f docs pass 2024-01-10 15:08:54 +01:00
Tobias Baunbaek
fb312aecc6 Update pictures 2023-12-11 10:08:29 +01:00
Tobias Baunbaek
282b8fcaae No abbreviation on first use 2023-12-08 16:17:59 +01:00
David Mark Clements
ba147975bc tweaks 2023-12-07 18:22:43 +01:00
David Mark Clements
d443d01b9e fixup 2023-12-07 17:59:24 +01:00
David Mark Clements
a4a7e5bfc9 subdirs, cli 2023-12-07 13:34:16 +01:00