From eaf5419e8cec7948b74ba1f0fcdec514d96230e7 Mon Sep 17 00:00:00 2001 From: Vishnu Raghav B Date: Thu, 12 Nov 2020 18:29:32 +0530 Subject: [PATCH] updated readme and license --- LICENSE | 4 ++-- README.md | 46 ++++++++++++++++++++++++++++++++++++++++------ 2 files changed, 42 insertions(+), 8 deletions(-) diff --git a/LICENSE b/LICENSE index 17709f14..6ee1017b 100644 --- a/LICENSE +++ b/LICENSE @@ -631,7 +631,7 @@ to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. - + EnRecipes - a simple, offline recipe manager. Copyright (C) 2020 Vishnu Raghav B This program is free software: you can redistribute it and/or modify @@ -652,7 +652,7 @@ Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: - Copyright (C) 2020 Vishnu Raghav B + EnRecipes Copyright (C) 2020 Vishnu Raghav B This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. diff --git a/README.md b/README.md index e9c23fe0..60778e77 100644 --- a/README.md +++ b/README.md @@ -2,27 +2,61 @@ > A simple, offline recipe manager. -EnRecipes is an easy to use, privacy-friendly app that lets you store, manage and share your recipes. +## Introduction -## Features: +EnRecipes is an easy to use, privacy-friendly digital cookbook that lets you create, manage and share your own recipes. -- Add your recipes +## Principles + +- Privacy by Design + +## Technologies + +- NativeScript-Vue + +## Assets + +- [Boxicons](https://boxicons.com/) +- Logo by [Vishnu Raghav](https://www.vishnuraghav.com/) + +## Features + +- Create recipes quickly - Add photo, notes and references to your recipes - Organise your recipes by category - Search for your recipes based on the title - Mark recipes as favorites and add them to your Try later list -- Scale your recipe ingredients easily +- Scale your recipe ingredients to serve more or less people - Get notified of the last time you tried a recipe -- Share your recipe as a nicely formated message. You can share the photo too. +- Share your recipe to anyone by any means as a nicely formatted message. You can share the recipe photo too. - Import/Export recipes - Light/Dark theme - 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 Lots of interesting features on the way... ## Credits This app was written in my free time using NativeScript. I would like to thank all those people who helped me understand the concepts during the process and my special thanks to the NativeScript team and the community. + +## License + +``` +EnRecipes - a simple, offline recipe manager. +Copyright (C) 2020 Vishnu Raghav B + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +```