From 742a10090eca90801c9c18e76bd6028e9cf2b096 Mon Sep 17 00:00:00 2001 From: Subash SN Date: Wed, 21 Feb 2024 14:16:19 +0100 Subject: [PATCH] Added note on Bare runtime + cross platform app example (#62) * Added Bare ref, expanded examples * Added cross platform mobile app * Improved Bare * mc * mc * mc --- README.md | 8 +++++--- SUMMARY.md | 1 + examples/cross-platform-pear-app.md | 9 +++++++++ 3 files changed, 15 insertions(+), 3 deletions(-) create mode 100644 examples/cross-platform-pear-app.md diff --git a/README.md b/README.md index 9dffa87..e1fe662 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,8 @@ References for utilizing the Pear runtime. * [Application-Programming-Interface (API)](./reference/api.md) * [Application Configuration](./reference/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. + ### Guides Guides on using the pear runtime to build and share P2P applications. @@ -84,9 +86,9 @@ Applications built using Pear. ### Examples Collection of example applications that can be used as reference during development. - -- [Bare on Mobile](./examples/bare-on-mobile.md) -- [React App using Pear](./examples/react-app-using-pear.md) +- [Cross-platform Pear App](./examples/cross-platform-pear-app.md): Cross-platform "Hello World" Pear application for Android and iOS. +- [Bare on Mobile](./examples/bare-on-mobile.md): Reference applications for using Bare runtime on Android and iOS. +- [React App using Pear](./examples/react-app-using-pear.md): Example application for building Pear applications using React framework. ## Stability indexing diff --git a/SUMMARY.md b/SUMMARY.md index 96d7505..5fea4c2 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -60,5 +60,6 @@ ### Examples +* [Cross-platform Pear App](examples/cross-platform-pear-app.md) * [Bare on Mobile](examples/bare-on-mobile.md) * [React App using Pear](examples/react-app-using-pear.md) \ No newline at end of file diff --git a/examples/cross-platform-pear-app.md b/examples/cross-platform-pear-app.md new file mode 100644 index 0000000..f5ffdcf --- /dev/null +++ b/examples/cross-platform-pear-app.md @@ -0,0 +1,9 @@ +# Cross-platform Pear App + +A "Hello World" example of a cross-platform Pear application for Android and iOS using [Bare](https://github.com/holepunchto/bare) and [Expo SDK](https://expo.dev/). + +- [Pear Expo Hello World](https://github.com/holepunchto/pear-expo-hello-world) + +> This above example is still a work in progress, please expect further improvements. + +Note that on mobile, the React Native UI runs on one thread and the Bare local backend runs on another thread and they both communicate via an IPC API. \ No newline at end of file