Update README.md

This commit is contained in:
2025-08-01 15:42:23 -06:00
parent 1be2cb425c
commit f7bd6643cb

View File

@@ -1,31 +1,23 @@
# Mealient # Mealient
## USAGE REQUIREMENTS
- Android 8.0 or higher
- A Mealie server running v3 or higher
## DISCLAIMERS ## DISCLAIMERS
This project is developed independently from the core Mealie project. It is NOT associated with the This project is developed independently from the core Mealie project. It is NOT associated with the core Mealie developers. **Any issues must be reported to the Mealient repository, NOT the Mealie repository.**
core Mealie developers. Any issues must be reported to the Mealient repository, NOT the Mealie
repository.
Also, this is a fork of the original Mealient project. All credit goes to Kirill Kamakin on GitHub for the original project. Also, this is a fork of the original Mealient project. All credit goes to Kirill Kamakin on GitHub for the original project.
## What is this? ## What is this?
An unofficial Android client for [Mealie](https://github.com/mealie-recipes/mealie/). It enables you An **unofficial** Android client for [Mealie](https://github.com/mealie-recipes/mealie/). It enables you
to to
easily access your recipes using an Android device. The main advantage over website is that easily access your recipes using an Android device. The main advantage over website is that
recipe data is stored locally and can be accessed without the Internet connection. recipe data is stored locally and can be accessed without the Internet connection.
## Status
Current version is a very early alpha which supports a small subset of the Mealie capabilities.
Displays the list of recipes, some information about each of the recipes, even recipe creation is
available!
The list of shopping lists is also available, each shopping list can be viewed and modified.
## How to install ## How to install
Download the latest apk from the releases page. Download the latest apk from the releases page.
## Contribution
Any contribution is greatly appreciated: translations, bug reports, feature requests and any PR.