breath-web-app/README.md

A Web & Mobile App to help you focus on and calm your breathing.

[![Breath Web App][icon]][app]

[![Node CI ~ test status][gh-badge]][gh-link]
[![Lighthouse audit][lh-badge]][lh-link]
[![Find PWA directory][find-badge]][find-link]
[![License: GPL][gpl-badge]][gpl]

# Breath #

A Web & Mobile App to help you focus on and calm your breathing.
__Currently in 'Beta'.__

_Try me!_ [__nfreear.github.io/breath__][app]


_Resonant breathing biofeedback training_ has [been shown][sutarto 2012] to be
[beneficial][wp] to relieve stress ([Moss 2004][]).

## Release notes

 * View the [Change log](./CHANGELOG.md),
 * Gist: [original SVG][gist]

---
## Browser support?

_The intention is to support the App on the latest version of the
ever-green browsers listed below, except for Internet Explorer_.

This is the current status, based on what I've managed to test so far!

 * ✅ _OK_ — Chrome _(desktop, Android)_,
 * ✅ _OK_ — Samsung _(Android)_,
 * ✅ _OK_ — Firefox _(desktop)_,
 * ✅ _OK_ — Safari _(Mac OS, iOS: iPhone)_,
 * ❌ _bug_ — MS Edge — _I'm investigating_,
 * ✖️ _NO_ — MS Internet Explorer — _not supported_!

---
## License

 * License: [GNU General Public License __(GPL-3.0)__][gpl].

[wp]: https://en.wikipedia.org/wiki/Biofeedback#Stress_reduction
  "Biofeedback on Wikipedia."
[sutarto 2012]: https://doi.org/10.1080%2F10803548.2012.11076959
"A.P. Sutarto, M.N.A Wahab & N.M. Zin (2012) Resonant Breathing Biofeedback Training for Stress Reduction Among Manufacturing Operators, Internat. J. of Occupational Safety and Ergonomics, 18:4, 549-561, DOI: 10.1080/10803548.2012.11076959; Retrieved 04-April-2020"
[pdf-moss 2004]: https://bfe.org/articles/issue1_final.pdf
"(PDF) Moss D. Heart rate variability (HRV) biofeedback. Psychophysiology Today. 2004;(1):4–11. Retrieved 04-April-2020."
[moss 2004]: https://scholar.google.com/scholar?q=Moss+%22Heart+rate+variability+%28HRV%29+biofeedback%22#
"Moss D. Heart rate variability (HRV) biofeedback. Psychophysiology Today. 2004;(1):4–11. On Google Scholar."
[eddie]: https://eddiestern.com/the-breathing-app/
[android]: https://play.google.com/store/apps/details?id=org.ayny.breathingapp#
  "The Breathing App, on Google Play for Android."
[ios]: https://apps.apple.com/us/app/the-breathing-app/id1285982210
  "The Breathing App, on the Apple App Store for iOS."
[sergey]: https://play.google.com/store/apps/developer?id=Sergey+Varichev
[video]: https://youtu.be/xXpsoGHnEiU?list=UUNMy2KojFn0jMbxbHZVppGw&index=4#
  "Breathing App Quick Start, 2017, on YouTube."
[pwa]: https://en.wikipedia.org/wiki/Progressive_web_application#Service_workers
[ball]: https://en.wikipedia.org/wiki/File:Racquetball_ball.svg
[anim-ball]: https://commons.wikimedia.org/wiki/File:Soccer_ball_animated.svg
[color]: https://www.rapidtables.com/web/color/color-wheel.html
[gist]: https://gist.github.com/nfreear/c8666ec92360d09c4f6d559a4e4d55ec
  "Gist: nfreear / breathing-animation.web-app.svg"
[gpl-badge]: docs/lib/badge-gpl.svg
[gpl]: https://gnu.org/licenses/gpl-3.0.html#content
  "© Nick Freear, 01-Apr-2020 | GNU General Public License version | GPL-3.0+"
[lh-badge]: docs/lib/badge-lighthouse.svg
  "Lighthouse audit report — 99.2% — (97 | 100 | 100 | 100)"
[lh-link]: https://lighthouse-dot-webdotdevsite.appspot.com/lh/html?url=https%3A//nfreear.github.io/breath/
[find-badge]: docs/lib/badge-findpwa.svg
[find-link]: https://findpwa.com/app/breath-web-app "'Breath' on findPWA"
[gh-badge]: https://github.com/nfreear/breath/workflows/Node%20CI/badge.svg
[gh-link]: https://github.com/nfreear/breath/actions "Node CI — Test status"
[app]: https://nfreear.github.io/breath/?utm_source=readme "Try the 'Breath' Web App (beta)"
[icon]: docs/lib/icon.svg