Skip to content

Commit

Permalink
fix install url in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pomdtr committed Dec 13, 2023
1 parent b433d90 commit deed0e2
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 5 deletions.
10 changes: 8 additions & 2 deletions hyper/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ Use Hyper as a [Sunbeam](https://sunbeam.sh) GUI.

## Installation

Use the Hyper CLI, bundled with your Hyper app, to install hyper-sunbeam
by entering the following into Hyper:
Use the Hyper CLI, bundled with your Hyper app, to install hyper-sunbeam:

```bash
hyper i hyper-sunbeam
Expand All @@ -33,3 +32,10 @@ module.exports = {
```

<sup>1</sup> For a list of valid shortcuts, see [Electron Accelerators](https://github.com/electron/electron/blob/master/docs/api/accelerator.md).

## Suggested Extensions

Hyper Sunbeam couples well with the following extensions:

- [hyperborder](https://github.com/webmatze/hyperborder) - cool gradiant borders
- [hyper-transparent](https://github.com/codealchemist/hyper-transparent) - nice blur effect on macOS
2 changes: 1 addition & 1 deletion www/frontend/docs/developer-guide/examples/devdocs.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ Now we can start by listing the docsets, select the one we are interested in, an

## Adding new root items

When we installed the extension using `sunbeam extension install ./devdocs.sh`, an entry was added to the `extensions` array in `~/.config/sunbeam/config.json`.
When we installed the extension using `sunbeam extension install ./devdocs.sh`, an entry was added to the `extensions` map in `~/.config/sunbeam/sunbeam.json`.

```json
{
Expand Down
2 changes: 1 addition & 1 deletion www/frontend/docs/developer-guide/publishing.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ You can publish an extension script as a release asset.

To link to a release asset from the latest release, use the following url:

```
```txt
https://github.com/<owner>/<repo>/releases/latest/download/<script>
```

Expand Down
2 changes: 1 addition & 1 deletion www/frontend/docs/user-guide/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Sunbeam extensions are just scripts. In order to install an extension, you only

```sh
# Install the devdocs extension from sunbeam repository
sunbeam extension install https://github.com/pomdtr/sunbeam/tree/main/extensions/devdocs.sh
sunbeam extension install https://raw.githubusercontent.com/pomdtr/sunbeam/main/extensions/devdocs.sh
```

> ⚠️ Extensions are not verified, nor sandboxed. They can do anything you can do on your computer. Make sure you trust the source / read the code before installing an extension.
Expand Down

0 comments on commit deed0e2

Please sign in to comment.