diff --git a/README.md b/README.md index 9ec9291497..a74e3a8c66 100644 --- a/README.md +++ b/README.md @@ -1,111 +1,88 @@
-Website • -Installation • -Docs • -Demo • -Discord + Website • + Installation • + Documentation • + Demo • + Discord
![Preview](docs/preview.png) ## 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 - -## Made by and for power users - -- 🔍 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 -- ↔️ 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** -- 📦 **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 -- 📥️ **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/). - -## Support our work -Tandoor is developed by volunteers in their free time just because its fun. That said earning -some money with the project allows us to spend more time on it and thus make improvements we otherwise couldn't. -Because of that there are several ways you can support us - -- **GitHub Sponsors** You can sponsor contributors of this project on GitHub: [vabene1111](https://github.com/sponsors/vabene1111) -- **Host at Hetzner** We have been very happy customers of Hetzner for multiple years for all of our projects. If you want to get into self-hosting or are tired of the expensive big providers, their cloud servers are a great place to get started. When you sign up via our [referral link](https://hetzner.cloud/?ref=ISdlrLmr9kGj) you will get 20€ worth of cloud credits and we get a small kickback too. -- **Let us host for you** We are offering a [hosted version](https://app.tandoor.dev) where all profits support us and the development of tandoor (currently only available in germany). +- 🥗 **Recipe Management**: Organize and curate your recipes with ease. +- 📆 **Meal Planning**: Schedule multiple meals for each day. +- 🛒 **Shopping Lists**: Generate lists from your meal plans or recipes. +- 📚 **Cookbooks**: Compile recipes into organized collections. +- 👪 **Collaboration**: Share recipes with family and friends. + +## Advanced Functionality +- 🔍 **Powerful Search**: Full-text search with advanced capabilities including [TrigramSimilarity](https://docs.djangoproject.com/en/3.0/ref/contrib/postgres/search/#trigram-similarity). +- 🏷️ **Tag Management**: Create, search, and batch-assign tags to streamline organization. +- ↔️ **Ingredient Merging**: Quickly merge and rename ingredients, tags, and units. +- 📥️ **Import Recipes**: Seamlessly import recipes from thousands of websites. +- ➗ **Fraction Support**: Handle both fractions and decimals effortlessly. +- 🐳 **Docker Compatibility**: Easy setup with included examples for Kubernetes, Unraid, and Synology. +- 🎨 **Customizable Themes**: Tailor the interface to your liking. +- 📦 **File Syncing**: Sync your files with Dropbox and Nextcloud. + +## Essential Features +- 📱 **Mobile Optimization**: Perfectly suited for mobile devices. +- 🌍 **Multi-Language Support**: Localized in various languages. +- 📥️ **Import Collections**: Migrate from other recipe managers with ease. +- ➕ **Additional Capabilities**: Recipe scaling, image compression, printing views, and supermarket integration. + +This application is designed for anyone wanting to organize and share their recipes. While it includes a basic permission system, it's primarily for personal use. + +## Documentation +Comprehensive documentation is available [here](https://docs.tandoor.dev/). + +## Support Our Work +Tandoor is a community-driven project developed by volunteers. If you appreciate our efforts, consider supporting us: + +- **GitHub Sponsors**: Sponsor contributors [here](https://github.com/sponsors/vabene1111). +- **Host with Hetzner**: Enjoy cloud credits with our [referral link](https://hetzner.cloud/?ref=ISdlrLmr9kGj). +- **Hosted Version**: Support development by using our [hosted version](https://app.tandoor.dev). ## Contributing -Contributions are welcome but please read [this](https://docs.tandoor.dev/contribute/guidelines/) **BEFORE** contributing anything! - -## 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 +We welcome contributions! Please review our [contribution guidelines](https://docs.tandoor.dev/contribute/guidelines/) before submitting. -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 | -