From b92ede3fe2e82af93072256f3f764b7b6f248961 Mon Sep 17 00:00:00 2001 From: vishnuraghavb Date: Mon, 8 Mar 2021 15:18:43 +0530 Subject: [PATCH] updated readme --- README.md | 125 ++++++++++++++++++++++++++---------------------------- 1 file changed, 61 insertions(+), 64 deletions(-) diff --git a/README.md b/README.md index b4dc471a..63ca5365 100644 --- a/README.md +++ b/README.md @@ -1,81 +1,80 @@

-

A simple, offline recipe manager

-

EnRecipes is an open source, privacy-friendly digital cookbook that lets you create, manage and share your recipes.

-
+

A Simple, Offline Recipe Manager

+

EnRecipes is an open source, privacy-friendly digital cookbook that lets you create, manage and share your recipes.

- - + +Translation status +

+
You can also get the latest release on GitHub +

+

Enjoying EnRecipes?

+

Please consider making a small donation to help fund the project. Developing an application, especially one that is open source and completely free, takes a lot of time and effort. +
+
+Donate to Vishnu Raghav

-

Features - Downloads - Screenshots - Future - Contributors - Credits - License

-
-

User Guide - Roadmap - Contribution Guide - Privacy Policy - Telegram Group - Website - Donate

+

Important Links

+

User Guide - Privacy Policy - Contribution Guide - Roadmap - Telegram Group - Website

## Features -- Create recipes quickly -- Add photo, notes and combinations to your recipes -- Organise your recipes by cuisine, category and tags -- Mark recipes as Favourites and add them to your Try Later list -- Quickly search for recipes by title or ingredient -- Scale your recipe ingredients to serve more or less people -- Get notified of the last time you tried a recipe -- Share your recipe to anyone by any means as a nicely formatted message. You can share the recipe photo too -- Shake device to view random recipe -- Create meal plans -- Import/Export recipes -- Light & Dark theme +- Create recipes quickly +- Add photo, notes and combinations to your recipes +- Organise your recipes by cuisine, category and tags +- Mark recipes as Favourites and add them to your Try Later list +- Quickly search for recipes by title or ingredient +- Scale your recipe ingredients to serve more or less people +- Get notified of the last time you tried a recipe +- Share your recipe to anyone by any means as a nicely formatted message. You can share the recipe photo too +- Shake device to view random recipe +- Create meal plans +- Import/Export recipes +- Light & Dark theme ## Highlights -- 100% free and open-source -- Private by Design -- No annoying ads or pop-ups -- No internet access is required and never asks for any unwanted permissions +- 100% free and open-source +- Private by Design +- No annoying ads or pop-ups +- No internet access is required and never asks for any unwanted permissions -**Languages supported**: Danish, Dutch, English, French, German, Italian, Norwegian Bokmål,Portuguese, Russian, Spanish and Tamil +**Languages being translated**: + +[![Translation status](https://hosted.weblate.org/widgets/enrecipes/-/app-translations/multi-auto.svg)](https://hosted.weblate.org/engage/enrecipes/) Check the [Roadmap](https://github.com/vishnuraghavb/EnRecipes/projects/1) for upcoming features. -Please read the User Guide to get the most out of EnRecipes. - -## Downloads - -You can get the latest release [here](https://github.com/vishnuraghavb/EnRecipes/releases/latest) - -[![PlayStore](assets/Images/google-play-badge.png)](https://play.google.com/store/apps/details?id=com.vishnuraghav.enrecipes) -[![IzzyOnDroid](assets/Images/IzzyOnDroid.png)](https://apt.izzysoft.de/fdroid/index/apk/com.vishnuraghav.enrecipes) +Please read the [User Guide](https://github.com/vishnuraghavb/EnRecipes/wiki/User-Guide) to get the most out of EnRecipes. ## Screenshots +||| +|:---:|:---:| +|**Home - Light theme**|**Home - Dark theme**| +||| +|**Side drawer**|**Recipe view**| +||| +|**Share menu**|**Scale ingredients**| +||| +|**Meal planner**|**Settings**| -[](fastlane/metadata/android/en-US/images/phoneScreenshots/1.png)[](fastlane/metadata/android/en-US/images/phoneScreenshots/2.png)[](fastlane/metadata/android/en-US/images/phoneScreenshots/3.png)[](fastlane/metadata/android/en-US/images/phoneScreenshots/4.png)[](fastlane/metadata/android/en-US/images/phoneScreenshots/5.png)[](fastlane/metadata/android/en-US/images/phoneScreenshots/6.png)[](fastlane/metadata/android/en-US/images/phoneScreenshots/7.png)[](fastlane/metadata/android/en-US/images/phoneScreenshots/8.png) -## Having issues, suggestions and feedback? +## Contribution + +Check out the [Roadmap](https://github.com/vishnuraghavb/EnRecipes/projects/1) and [Issues](https://github.com/vishnuraghavb/EnRecipes/issues) before proceeding. + +Your feedback and suggestions are very important to make EnRecipes the best. If you have an idea to improve EnRecipes, [join the Telegram group](#having-issues-suggestions-and-feedback) to start discussing. I'm always open to ideas ;) + +### Having issues, suggestions and feedback? You can, -- [Create an issue here](https://github.com/vishnuraghavb/EnRecipes/issues) -- [Join the Telegram group](http://t.me/enrecipes) (quicker replies and best for discussion) -- Contact me at apps@vishnuraghav.com +- [Create an issue here](https://github.com/vishnuraghavb/EnRecipes/issues) +- [Join the Telegram group](http://t.me/enrecipes) (quicker replies) +- Contact me at apps@vishnuraghav.com -## Future - -Check out the [roadmap](https://github.com/vishnuraghavb/EnRecipes/projects/1) to see the upcoming features of EnRecipes. - -Your feedback and suggestions are very important to make EnRecipes the best. If you have an idea to improve EnRecipes, [do let me know](#having-issues-suggestions-and-feedback). I'm always open to ideas ;) - -## Contributors - -### Translators - -- [mondstern](https://codeberg.org/mondstern) (Danish, Dutch and German)(discontinued) -- [EpicalXYZ](https://github.com/epicalxyz) (Portuguese) -- [dm9pZCAq](https://github.com/dm9pZCAq) (Russian) -- [AHaro88](https://github.com/taraletti) (Spanish) -- [RAPXT](https://github.com/RAPXT) (German) - -### Help translate EnRecipes +### Looking to translate the app to your own language? EnRecipes is being translated using [Weblate](https://hosted.weblate.org/engage/enrecipes/). See [translation instructions](https://github.com/vishnuraghavb/EnRecipes/wiki/Translation-Instructions) in the wiki for more information. @@ -89,17 +88,19 @@ This app was written in my free time using NativeScript-Vue. I would like to tha ### Recipes used in the Screenshots -- **Meen Pollichathu** by [Bency Veronica](https://www.instagram.com/bencys_lil_kitchen) -- **Curd Vada** by P. Shanmugalakshmi -- **Roasted Chicken Biriyani** by [Ranga](https://www.youtube.com/channel/UC6ONI92scjwMmk3IITKIx-g) +- **Meen Pollichathu** by [Bency Veronica](https://www.instagram.com/bencys_lil_kitchen) +- **Curd Vada** by P. Shanmugalakshmi +- **Roasted Chicken Biriyani** by [Ranga](https://www.youtube.com/channel/UC6ONI92scjwMmk3IITKIx-g) ### Assets -- Icon font and Logo by [Vishnu Raghav](https://www.vishnuraghav.com/) +- Icon font and Logo by [Vishnu Raghav](https://www.vishnuraghav.com/) ## License - EnRecipes - a simple, offline recipe manager. +GNU GPLv3 Image + + EnRecipes - A Simple, Offline Recipe Manager Copyright (C) 2020 Vishnu Raghav B This program is free software: you can redistribute it and/or modify @@ -114,7 +115,3 @@ This app was written in my free time using NativeScript-Vue. I would like to tha You should have received a copy of the GNU General Public License along with this program. If not, see . - -## Support me - -Donate to Vishnu Raghav