Files
breeze/README.md
T

81 lines
3.5 KiB
Markdown

<p align="center">
<img src="assets/app/readme-banner.png" alt="Inner Breeze" width="100%">
</p>
<p align="center">
<a href="https://play.google.com/store/apps/details?id=xyz.waozi.inbe">
<img src="assets/app/badge-google-play.png" alt="Get it on Google Play" height="56">
</a>
<a href="https://f-droid.org/packages/xyz.waozi.inbe/">
<img src="assets/app/badge-f-droid.png" alt="Get it on F-Droid" height="56">
</a>
</p>
# Inner Breeze
Free, open-source apps for breathing, meditation, habits and everyday life.
Use them offline, keep your data on your device, and optionally connect an
account to sync across devices.
[Download the latest release](https://github.com/waozixyz/breeze/releases/latest)
· [What's new](CHANGELOG.md)
## Make space for yourself
- **Practice:** guided breathing, meditation, Astral Projection, Sun Salutation,
a 7-Minute Workout, with animated guides and optional narration.
- **Habits:** track daily goals, practices and habits you want to avoid; follow
your history and choose your own rewards.
- **Diary and Photos:** write, reflect and keep pictures together, with shared
photo storage and automatic compression of new uploads.
- **Lists:** organize tasks and share lists with friends, choosing who can
read, edit or manage them.
- **Lumi:** a firefly companion for starting practices, managing habits and
changing your app. Offline commands work without an AI connection.
- **Your apps:** arrange Apps as a list or grid, choose colours and icons,
listen to ambient Radio, and explore Arcade games and achievements.
- **Profile:** compare practice and game rankings with friends in Leaderboard.
Only installed apps, ranked practices and installed games appear there.
## A look inside
<p align="center">
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/01-apps.png" alt="Apps you can arrange and personalize" width="30%">
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/03-practice-home.png" alt="Guided breathing and movement practices" width="30%">
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/04-sun-salutation.png" alt="Animated Sun Salutation practice" width="30%">
</p>
<p align="center"><em>Apps · Practices · Sun Salutation</em></p>
<p align="center">
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/05-habits.png" alt="Habit goals and daily history" width="30%">
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/07-diary.png" alt="Diary for everyday reflection" width="30%">
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/02-lumi-customize.png" alt="Lumi helping customize Inner Breeze" width="30%">
</p>
<p align="center"><em>Habits · Diary · Lumi</em></p>
Tai Chi is an optional Dew unlock outside Google Play.
## Your data and choices
Your data is stored locally. Account sync is optional. Lumi starts offline;
connecting an AI provider asks for your agreement to the data sharing shown
in the app. Use Inner Breeze's service or configure your own provider.
[Privacy policy](https://inbe.waozi.xyz/privacy.html)
· [Account recovery and sync](docs/SYNC_RECOVERY.md)
· [Appearance](docs/appearance.md)
## Build and contribute
```sh
make native
make run
```
See the [build guide](docs/building.md) for Android, web, dependencies and tests,
the [F-Droid checks](docs/fdroid.md), and
[Contributing](CONTRIBUTING.md) to report bugs or make changes.
[Report security issues privately](SECURITY.md).
BSD 3-Clause. See [LICENSE](LICENSE).