diff --git a/README.md b/README.md index dbd087502..cd6442de9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
+Website • Installation • -Documentation • +Docs • Demo • -Discord server +Discord
 -# Your Feedback +## Core Features +- 🥗 **Manage your recipes** - Manage your ever growing recipe collection +- 📆 **Plan** - multiple meals for each day +- 🛒 **Shopping lists** - via the meal plan or straight from recipes +- 📚 **Cookbooks** - collect recipes into books +- 👪 **Share and collaborate** on recipes with friends and family -Share some information on how you use Tandoor to help me improve the application [Google Survey](https://forms.gle/qNfLK2tWTeWHe9Qd7) +## Made by and for power users -## Features - -- 📦 **Sync** files with Dropbox and Nextcloud (more can easily be added) -- 🔍 Powerful **search** with Djangos [TrigramSimilarity](https://docs.djangoproject.com/en/3.0/ref/contrib/postgres/search/#trigram-similarity) +- 🔍 Powerful & customizable **search** with fulltext support and [TrigramSimilarity](https://docs.djangoproject.com/en/3.0/ref/contrib/postgres/search/#trigram-similarity) - 🏷️ Create and search for **tags**, assign them in batch to all files matching certain filters -- 📄 **Create recipes** locally within a nice, standardized web interface -- ⬇️ **Import recipes** from thousands of websites supporting [ld+json or microdata](https://schema.org/Recipe) -- 📱 Optimized for use on **mobile** devices like phones and tablets -- 🛒 Generate **shopping** lists from recipes -- 📆 Create a **Plan** on what to eat when -- 👪 **Share** recipes with friends and comment on them to suggest or remember changes you made -- ➗ automatically convert decimal units to **fractions** for those who like this -- 🐳 Easy setup with **Docker** and included examples for Kubernetes, Unraid and Synology +- ↔️ Quickly merge and rename ingredients, tags and units +- 📥️ **Import recipes** from thousands of websites supporting [ld+json or microdata](https://schema.org/Recipe) +- ➗ Support for **fractions** or decimals +- 🐳 Easy setup with **Docker** and included examples for **Kubernetes**, **Unraid** and **Synology** - 🎨 Customize your interface with **themes** -- ✉️ Export and import recipes from other users +- 📦 **Sync** files with Dropbox and Nextcloud + +## All the must haves + +- 📱Optimized for use on **mobile** devices - 🌍 localized in many languages thanks to the awesome community -- ➕ Many more like recipe scaling, image compression, cookbooks, printing views, ... +- 📥️ **Import your collection** from many other [recipe managers](https://docs.tandoor.dev/features/import_export/) +- ➕ Many more like recipe scaling, image compression, printing views and supermarkets This application is meant for people with a collection of recipes they want to share with family and friends or simply store them in a nicely organized way. A basic permission system exists but this application is not meant to be run as a public page. + +## Docs + Documentation can be found [here](https://docs.tandoor.dev/). -While this application has been around for a while and is actively used by many (including myself), it is still considered -**beta** software that has a lot of rough edges and unpolished parts. +## Contributing + +You can help out with the ongoing development by looking for potential bugs in our code base, or by contributing new features. We are always welcoming new pull requests containing bug fixes, refactors and new features. We have a list of tasks and bugs on our issue tracker on Github. Please comment on issues if you want to contribute with, to avoid duplicating effort. + +## Your Feedback + +Share some information on how you use Tandoor to help me improve the application [Google Survey](https://forms.gle/qNfLK2tWTeWHe9Qd7) + +## Get in touch + +| Discord | +We have a public Discord server that anyone can join. This is where all our developers and contributors hang out and where we make announcements | +
| You can follow our Twitter account to get updates on new features or releases | +
|
- [[formatDateDayname(d)]] [[formatDateDay(d)]]. - - |
-
|---|
| - [[ meal_plan[t.name].name]] - - ([[ user_names[t.created_by] ]]) - - | -
|
-
-
-
-
-
-
-
-
-
-
-
-
-
- |
-
-Installation • -Documentation • -Demo +Website • +Installation • +Docs • +Demo • +Discord
 -!!! info "WIP" - The documentation is work in progress. New information will be added over time. - Feel free to open pull requests to enhance the documentation. +## Core Features +- 🥗 **Manage your recipes** with a fast and intuitive editor +- 📆 **Plan** multiple meals for each day +- 🛒 **Shopping lists** via the meal plan or straight from recipes +- 📚 **Cookbooks** collect recipes into books +- 👪 **Share and collaborate** on recipes with friends and family -## Features +## Made by and for power users -- 📦 **Sync** files with Dropbox and Nextcloud (more can easily be added) -- 🔍 Powerful **search** with Djangos [TrigramSimilarity](https://docs.djangoproject.com/en/3.0/ref/contrib/postgres/search/#trigram-similarity) +- 🔍 Powerful & customizable **search** with fulltext support and [TrigramSimilarity](https://docs.djangoproject.com/en/3.0/ref/contrib/postgres/search/#trigram-similarity) - 🏷️ Create and search for **tags**, assign them in batch to all files matching certain filters -- 📄 **Create recipes** locally within a nice, standardized web interface -- ⬇️ **Import recipes** from thousands of websites supporting [ld+json or microdata](https://schema.org/Recipe) -- 📱 Optimized for use on **mobile** devices like phones and tablets -- 🛒 Generate **shopping** lists from recipes -- 📆 Create a **Plan** on what to eat when -- 👪 **Share** recipes with friends and comment on them to suggest or remember changes you made -- ➗ automatically convert decimal units to **fractions** for those who like this -- 🐳 Easy setup with **Docker** and included examples for Kubernetes, Unraid and Synology +- ↔️ Quickly merge and rename ingredients, tags and units +- 📥️ **Import recipes** from thousands of websites supporting [ld+json or microdata](https://schema.org/Recipe) +- ➗ Support for **fractions** or decimals +- 🐳 Easy setup with **Docker** and included examples for **Kubernetes**, **Unraid** and **Synology** - 🎨 Customize your interface with **themes** -- ✉️ Export and import recipes from other users +- 📦 **Sync** files with Dropbox and Nextcloud + +## All the must haves + +- 📱Optimized for use on **mobile** devices - 🌍 localized in many languages thanks to the awesome community -- ➕ Many more like recipe scaling, image compression, cookbooks, printing views, ... +- 📥️ **Import your collection** from many other [recipe managers](https://docs.tandoor.dev/features/import_export/) +- ➕ Many more like recipe scaling, image compression, printing views and supermarkets +This application is meant for people with a collection of recipes they want to share with family and friends or simply +store them in a nicely organized way. A basic permission system exists but this application is not meant to be run as +a public page. +## Your Feedback + +Share some information on how you use Tandoor to help me improve the application [Google Survey](https://forms.gle/qNfLK2tWTeWHe9Qd7) + +## Get in touch + +| Discord | +We have a public Discord server that anyone can join. This is where all our developers and contributors hang out and where we make announcements | +
| You can follow our Twitter account to get updates on new features or releases | +