Skip to content

Commit

Permalink
docs: Add Key Features to README (#3678)
Browse files Browse the repository at this point in the history
Co-authored-by: Hayden <[email protected]>
  • Loading branch information
boc-the-git and hay-kot authored Jun 3, 2024
1 parent 99a13bd commit 4aec294
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<h3 align="center">Mealie</h3>

<p align="center">
A Place for All Your Recipes
A Place For All Your Recipes
<br />
<a href="https://docs.mealie.io/"><strong>Explore the docs »</strong></a>
<a href="https://github.com/mealie-recipes/mealie">
Expand All @@ -38,12 +38,20 @@

# About The Project

Mealie is a self hosted recipe manager and meal planner with a RestAPI backend and a reactive frontend application built in Vue for a pleasant user experience for the whole family. Easily add recipes into your database by providing the URL and Mealie will automatically import the relevant data, or add a family recipe with the UI editor. Mealie also provides an API for interactions from 3rd party applications.
Mealie is a self hosted recipe manager, meal planner and shopping list with a RestAPI backend and a reactive frontend built in Vue for a pleasant user experience for the whole family. Easily add recipes into your database by providing the URL and Mealie will automatically import the relevant data, or add a family recipe with the UI editor. Mealie also provides an API for interactions from 3rd party applications.

- [Remember to join the Discord](https://discord.gg/QuStdQGSGK)!
- [Documentation](https://docs.mealie.io/)


## Key Features
- Recipe imports: Create recipes, by **importing from a URL** or entering data manually
- Meal Planner: Use the **Meal Planner** to plan your what you'll cook for the next week
- Shopping List: Put the necessary ingredients on your **Shopping List**, organised into sections of your local supermarket
- Cookbooks: Group recipes into **Cookbooks** based on your own criteria
- Docker: Easy **Docker** deployment
- Localisation: **Translations** for 35+ languages

<!-- CONTRIBUTING -->
## Contributing

Expand All @@ -58,7 +66,7 @@ If you are not a coder, you can still contribute financially. Financial contribu

### Translations

Translations can be a great way for **non-coders** to contribute to project. We use [Crowdin](https://crowdin.com/project/mealie) to allow several contributors to work on translating Mealie. You can simply help by voting for your preferred translations, or even by completely translating Mealie into a new language.
Translations can be a great way for **non-coders** to contribute to the project. We use [Crowdin](https://crowdin.com/project/mealie) to allow several contributors to work on translating Mealie. You can simply help by voting for your preferred translations, or even by completely translating Mealie into a new language.

For more information, check out the translation page on the [contributor's guide](https://nightly.mealie.io/contributors/translating/).

Expand Down
6 changes: 5 additions & 1 deletion docs/docs/documentation/getting-started/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,14 @@ Mealie offers two main ways to create recipes. You can use the integrated recipe

Mealie supports importing recipes from a few other sources besides websites. Currently the following sources are supported:

- Mealie Pre v1
- Tandoor
- Nextcloud Cookbooks
- Paprika
- Chowdown
- Plan to Eat
- Recipe Keeper
- Copy Me That
- My Recipe Box

You can access these options on your installation at the `/group/migrations` page on your installation. If you'd like to see another source added, feel free to request so on Github.

Expand Down

0 comments on commit 4aec294

Please sign in to comment.