Skip to content

Commit

Permalink
move bare ref and update links (#93)
Browse files Browse the repository at this point in the history
* move bare ref and update links

* move pear ref into subfolder

* update README

* tiny fix

---------

Co-authored-by: Vivek Singh <[email protected]>
  • Loading branch information
heyitsvi and Vivek Singh authored Mar 21, 2024
1 parent 497290c commit 20ca822
Show file tree
Hide file tree
Showing 11 changed files with 14 additions and 14 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ Welcome to the Internet of Peers

References for utilizing the Pear runtime.

* [Command-Line-Interface (CLI)](./reference/cli.md)
* [Application-Programming-Interface (API)](./reference/api.md)
* [Application Configuration](./reference/configuration.md)
* [Command-Line-Interface (CLI)](./reference/pear/cli.md)
* [Application-Programming-Interface (API)](./reference/pear/api.md)
* [Application Configuration](./reference/pear/configuration.md)

> The Pear runtime uses [Bare](https://github.com/holepunchto/bare) JavaScript runtime, which is a small and modular JavaScript runtime for desktop and mobile. To learn more, see [Bare Reference](./bare-reference/overview.md).
> The Pear runtime uses [Bare](https://github.com/holepunchto/bare) JavaScript runtime, which is a small and modular JavaScript runtime for desktop and mobile. To learn more, see [Bare Reference](./reference/bare/overview.md).
### Guides

Expand Down
14 changes: 7 additions & 7 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@

### Pear runtime

* [Command-Line-Interface (CLI)](./reference/cli.md)
* [Application-Programming-Interface (API)](./reference/api.md)
* [Application Configuration](./reference/configuration.md)
* [Command-Line-Interface (CLI)](./reference/pear/cli.md)
* [Application-Programming-Interface (API)](./reference/pear/api.md)
* [Application Configuration](./reference/pear/configuration.md)

### Bare reference
* [Overview](./bare-reference/overview.md)
* [Application-Programming-Interface (API)](./bare-reference/api.md)
* [Node.js Compatibility with Bare](./bare-reference/nodejs-compatibility-with-bare.md)
* [Bare Modules](./bare-reference/bare-modules.md)
* [Overview](./reference/bare/overview.md)
* [Application-Programming-Interface (API)](./reference/bare/api.md)
* [Node.js Compatibility with Bare](./reference/bare/nodejs-compatibility-with-bare.md)
* [Bare Modules](./reference/bare/bare-modules.md)

### Guides

Expand Down
2 changes: 1 addition & 1 deletion guide/making-a-pear-desktop-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ function onMessageAdded (from, message) {
}
```

> Note that the `pear` dependency is used, even though it was not installed. This is the [Pear API](../reference/api.md), available to any Pear project.
> Note that the `pear` dependency is used, even though it was not installed. This is the [Pear API](../reference/pear/api.md), available to any Pear project.

## Step 4. Chat
Expand Down
4 changes: 2 additions & 2 deletions guide/starting-a-pear-desktop-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The app should now show:

![Automatic reload](../assets/chat-app-2.png)

> Live reload with hot-module reloading is possible by using the `pear.watch` configuration and the [`pear.updates`](../reference/api.md#pearupdateslistener-async-functionfunction) API. The [pear-hotmods](https://github.com/holepunchto/pear-hotmods) convenience module can also be used.
> Live reload with hot-module reloading is possible by using the `pear.watch` configuration and the [`pear.updates`](../reference/pear/api.md#pearupdateslistener-async-functionfunction) API. The [pear-hotmods](https://github.com/holepunchto/pear-hotmods) convenience module can also be used.
## Step 4. Configuration

Expand All @@ -69,7 +69,7 @@ Open `package.json` and update it to:

Close the app and re-run `pear dev` to see the changes: the background is now light blue, and the initial window size is different.

See the [Configuration Documentation](../reference/configuration.md) for all options.
See the [Configuration Documentation](../reference/pear/configuration.md) for all options.


## Next
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 20ca822

Please sign in to comment.