Improve disclaimer wording and fill README.md
This commit is contained in:
37
README.md
37
README.md
@@ -1,7 +1,36 @@
|
||||
# DISCLAIMER
|
||||
# Mealient
|
||||
|
||||
This is an unofficial client for recipe manager Mealie. The application is developed independently from the core Mealie project. Any issues or feature request must be sent to the Mealient repository, NOT the Mealie repository.
|
||||
## DISCLAIMER
|
||||
|
||||
# Mealient Android Application
|
||||
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.
|
||||
|
||||
An Android client for [Mealie](https://hay-kot.github.io/mealie/). Easily access your recipes using your phone.
|
||||
## What is this?
|
||||
|
||||
An unofficial Android client for [Mealie](https://hay-kot.github.io/mealie/). It enables you to
|
||||
easily access your recipes using via Android phone. The main goal is to have everything stored
|
||||
locally to access it without Internet connection which is impossible with web site version.
|
||||
|
||||
## Status
|
||||
|
||||
Current version is a very early alpha which supports a tiny portion of the Mealie capabilites. There
|
||||
is a lot of work ahead, do not expect much. Having said that, you can list your recipes and read the
|
||||
instructions/ingredients for each of them.
|
||||
|
||||
## Screenshots
|
||||
|
||||
[login-screen](screenshots/login.webp)
|
||||
[recipes-screen](screenshots/recipes.webp)
|
||||
[recipe-info-screen](screenshots/recipe_info.webp)
|
||||
[usage](screenshots/usage.gif)
|
||||
|
||||
## How to install
|
||||
|
||||
Download the latest apk from the releases page.
|
||||
|
||||
## Contribution
|
||||
|
||||
Any contribution is greatly appreciated. Including translations, new issues, feature requests and
|
||||
typo corrections. I won't specify any rules until I have to ask the same thing multiple times. Just
|
||||
use the common sense.
|
||||
Reference in New Issue
Block a user