updated readme
This commit is contained in:
vishnuraghavb
parent
f9e0234aec
commit
b92ede3fe2
125
README.md
125
README.md
|
|
@ -1,81 +1,80 @@
|
|||
<p align="center"><a href="https://enrecipes.vercel.app"><img src="fastlane/metadata/android/en-US/images/featureGraphic.png" width="100%"></a></p>
|
||||
|
||||
<h3 align="center">A simple, offline recipe manager</h3>
|
||||
<h4 align="center">EnRecipes is an open source, privacy-friendly digital cookbook that lets you create, manage and share your recipes.</h4>
|
||||
<br>
|
||||
<h1 align="center">A Simple, Offline Recipe Manager</h1>
|
||||
<p align="center">EnRecipes is an open source, privacy-friendly digital cookbook that lets you create, manage and share your recipes.</p>
|
||||
<p align="center">
|
||||
<a href="https://github.com/vishnuraghavb/EnRecipes/releases" alt="Release version"><img src="https://img.shields.io/github/v/release/vishnuraghavb/EnRecipes?label=Release"></a> <a href="https://www.gnu.org/licenses/gpl-3.0" alt="License: GPLv3"><img src="https://img.shields.io/badge/License-GPL%20v3-blue"></a> <a href="https://github.com/vishnuraghavb/EnRecipes/issues" alt="GitHub issues"><img src="https://img.shields.io/github/issues/vishnuraghavb/EnRecipes?label=Issues"></a> <a href="https://liberapay.com/vishnuraghavb/donate" alt="Translation Status"><img src="https://img.shields.io/liberapay/patrons/vishnuraghavb.svg?logo=liberapay"></a> <a href="https://www.vishnuraghav.com/donate" alt="Donate"><img src="https://img.shields.io/badge/Donate%20to-Vishnu%20Raghav-brightgreen"></a>
|
||||
|
||||
<a href="https://www.gnu.org/licenses/gpl-3.0" alt="License: GPLv3"><img src="https://img.shields.io/badge/license-GPL%20v3-blue"></a> <a href="https://github.com/vishnuraghavb/EnRecipes/releases" alt="Release version"><img src="https://img.shields.io/github/v/release/vishnuraghavb/EnRecipes?color=ff5200"/></a> <a href="https://hosted.weblate.org/engage/enrecipes/">
|
||||
<img src="https://hosted.weblate.org/widgets/enrecipes/-/app-translations/svg-badge.svg" alt="Translation status" /></a>
|
||||
<p align="center">
|
||||
<a href="https://play.google.com/store/apps/details?id=com.vishnuraghav.enrecipes"><img src="assets/Images/google-play-badge.png" height="80"/></a><a href="https://apt.izzysoft.de/fdroid/index/apk/com.vishnuraghav.enrecipes"><img src="assets/Images/IzzyOnDroid.png" height="80"/></a><br>You can also get the <a href="https://github.com/vishnuraghavb/EnRecipes/releases/latest">latest release on GitHub</a>
|
||||
</p>
|
||||
<h2 align="center">Enjoying EnRecipes?</h2>
|
||||
<p align="center">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.
|
||||
<br>
|
||||
<br>
|
||||
<a href="https://www.vishnuraghav.com/donate/"><img alt="Donate to Vishnu Raghav" src="assets/Images/donate.svg" width="240"></a></p>
|
||||
<hr>
|
||||
<p align="center"><a href="#features">Features</a> - <a href="#downloads">Downloads</a> - <a href="#screenshots">Screenshots</a> - <a href="#future">Future</a> - <a href="#contributors">Contributors</a> - <a href="#credits">Credits</a> - <a href="#license">License</a></p>
|
||||
<hr>
|
||||
<p align="center"><a href="https://github.com/vishnuraghavb/EnRecipes/wiki/User-Guide">User Guide</a> - <a href="https://github.com/vishnuraghavb/EnRecipes/projects/1">Roadmap</a> - <a href="https://github.com/vishnuraghavb/EnRecipes/blob/main/CONTRIBUTING.md">Contribution Guide</a> - <a href="https://github.com/vishnuraghavb/EnRecipes/blob/main/PRIVACY.md">Privacy Policy</a> - <a href="https://t.me/enrecipes/">Telegram Group</a> - <a href="https://enrecipes.vercel.app/">Website</a> - <a href="https://www.vishnuraghav.com/donate/">Donate</a></p>
|
||||
<h3 align="center">Important Links</h3>
|
||||
<p align="center"><a href="https://github.com/vishnuraghavb/EnRecipes/wiki/User-Guide">User Guide</a> - <a href="https://github.com/vishnuraghavb/EnRecipes/blob/main/PRIVACY.md">Privacy Policy</a> - <a href="https://github.com/vishnuraghavb/EnRecipes/blob/main/CONTRIBUTING.md">Contribution Guide</a> - <a href="https://github.com/vishnuraghavb/EnRecipes/projects/1">Roadmap</a> - <a href="https://t.me/enrecipes/">Telegram Group</a> - <a href="https://enrecipes.vercel.app/">Website</a></p>
|
||||
<hr>
|
||||
|
||||
## 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**:
|
||||
|
||||
[](https://hosted.weblate.org/engage/enrecipes/)
|
||||
|
||||
Check the [Roadmap](https://github.com/vishnuraghavb/EnRecipes/projects/1) for upcoming features.
|
||||
|
||||
Please read the <a href="https://github.com/vishnuraghavb/EnRecipes/wiki/User-Guide">User Guide</a> to get the most out of EnRecipes.
|
||||
|
||||
## Downloads
|
||||
|
||||
You can get the latest release [here](https://github.com/vishnuraghavb/EnRecipes/releases/latest)
|
||||
|
||||
[](https://play.google.com/store/apps/details?id=com.vishnuraghav.enrecipes)
|
||||
[](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
|
||||
|<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/1.png" width=276>|<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/2.png" width=276>|
|
||||
|:---:|:---:|
|
||||
|**Home - Light theme**|**Home - Dark theme**|
|
||||
|<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/3.png" width=276>|<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/4.png" width=276>|
|
||||
|**Side drawer**|**Recipe view**|
|
||||
|<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/5.png" width=276>|<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/6.png" width=276>|
|
||||
|**Share menu**|**Scale ingredients**|
|
||||
|<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/7.png" width=276>|<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/8.png" width=276>|
|
||||
|**Meal planner**|**Settings**|
|
||||
|
||||
[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/1.png" width=276>](fastlane/metadata/android/en-US/images/phoneScreenshots/1.png)[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/2.png" width=276>](fastlane/metadata/android/en-US/images/phoneScreenshots/2.png)[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/3.png" width=276>](fastlane/metadata/android/en-US/images/phoneScreenshots/3.png)[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/4.png" width=276>](fastlane/metadata/android/en-US/images/phoneScreenshots/4.png)[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/5.png" width=276>](fastlane/metadata/android/en-US/images/phoneScreenshots/5.png)[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/6.png" width=276>](fastlane/metadata/android/en-US/images/phoneScreenshots/6.png)[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/7.png" width=276>](fastlane/metadata/android/en-US/images/phoneScreenshots/7.png)[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/8.png" width=276>](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.
|
||||
<a href="http://www.gnu.org/licenses/gpl-3.0.en.html" rel="nofollow"><img src="https://camo.githubusercontent.com/317e8956b95d7cd7ebdc2a75b836f19dee3c1ae5fa0fce5b277338e648880d4f/68747470733a2f2f7777772e676e752e6f72672f67726170686963732f67706c76332d3132377835312e706e67" alt="GNU GPLv3 Image"></a>
|
||||
|
||||
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 <https://www.gnu.org/licenses/>.
|
||||
|
||||
## Support me
|
||||
|
||||
<a href="https://www.vishnuraghav.com/donate/"><img alt="Donate to Vishnu Raghav" src="assets/Images/donate.svg" width="207"></a>
|
||||
|
|
|
|||
Loading…
Reference in a new issue