From 0858941ae1d9efa1342feb57cd7fee40db8929eb Mon Sep 17 00:00:00 2001 From: Subash SN Date: Wed, 21 Feb 2024 10:14:37 +0100 Subject: [PATCH] Added examples (#61) --- README.md | 7 +++++++ SUMMARY.md | 7 ++++++- examples/bare-on-mobile.md | 10 ++++++++++ examples/react-app-using-pear.md | 7 +++++++ 4 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 examples/bare-on-mobile.md create mode 100644 examples/react-app-using-pear.md diff --git a/README.md b/README.md index 7f5f61b..9dffa87 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,13 @@ Applications built using Pear. - [Keet](./apps/keet.md): A peer-to-peer chat and video-conferencing application with end-to-end encryption. +### 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) + ## Stability indexing Throughout the documentation, indications of stability are provided. Some modules are well-established and used widely, making them highly unlikely to ever change. Other modules may be new, experimental, or known to have risks associated with their use. diff --git a/SUMMARY.md b/SUMMARY.md index 7066e8c..96d7505 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -56,4 +56,9 @@ ### Apps -* [Keet](apps/keet.md) \ No newline at end of file +* [Keet](apps/keet.md) + +### Examples + +* [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/bare-on-mobile.md b/examples/bare-on-mobile.md new file mode 100644 index 0000000..ba0baaf --- /dev/null +++ b/examples/bare-on-mobile.md @@ -0,0 +1,10 @@ +# Bare on Mobile + +The Bare JavaScript runtime runs just as well on your phone as on your laptop. + +Below example applications can be used as a reference for building mobile applications using Bare: + +- [Bare Android](https://github.com/holepunchto/bare-android) +- [Bare iOS](https://github.com/holepunchto/bare-ios) + +For further reference on using Bare, please refer to [GitHub (Bare)](https://github.com/holepunchto/bare) \ No newline at end of file diff --git a/examples/react-app-using-pear.md b/examples/react-app-using-pear.md new file mode 100644 index 0000000..2a29abc --- /dev/null +++ b/examples/react-app-using-pear.md @@ -0,0 +1,7 @@ +# Pear React Application + +Below is an example of a Filesharing application built on the React framework using Pear. + +- (Filesharing React App Example)[https://github.com/holepunchto/filesharing-react-app-example] + +For further reference on using the Pear runtime, please refer to [Pear](../README.md#pear-runtime). \ No newline at end of file