From acede49efb64aed7bcf3d24cc909bd052956d79c Mon Sep 17 00:00:00 2001 From: Tom Bursch Date: Fri, 13 Sep 2024 11:07:25 +0200 Subject: [PATCH] docs: Update --- README.md | 3 ++- docs/docs/index.md | 1 + docs/docs/self-hosting/index.md | 1 + docs/docs/self-hosting/ingredient_parsing.md | 1 - 4 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6f165252..6ce3307b 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,7 @@ KitchenOwl is a smart self-hosted grocery list and recipe manager. Easily add it - Add items to your shopping list and sync them in real-time with multiple users - Partial offline support, so you don't lose track of what to buy even when there is no signal - Manage recipes and add them to your shopping list +- Share recipes with friends and family - Create a meal plan to always know what you'll be eating - Manage balances and track expenses of your household @@ -105,7 +106,7 @@ KitchenOwl is moving fast, to stay updated consider starring and watching the re ### 💬 Status -- [x] Public Alpha: Still working on stuff (sometimes things might break) +- [x] Public Alpha: Still working on stuff (rarely things might break) - [ ] Public Beta: Stable and most planned features complete - [ ] Public: Production-ready diff --git a/docs/docs/index.md b/docs/docs/index.md index a6f3fd64..5e4c4965 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -32,6 +32,7 @@ Please take a quick look at [Tips & Tricks](./Tips-&-Tricks/index.md) to get the - Add items to your shopping list and sync them in real-time with multiple users - Partial offline support, so you don't lose track of what to buy even when there is no signal - Manage recipes and add them to your shopping list +- Share recipes with friends and family - Create a meal plan to always know what you'll be eating - Manage balances and track expenses of your household diff --git a/docs/docs/self-hosting/index.md b/docs/docs/self-hosting/index.md index c05d9cea..8e9c2985 100644 --- a/docs/docs/self-hosting/index.md +++ b/docs/docs/self-hosting/index.md @@ -85,3 +85,4 @@ Here is a list of community maintained install methods: - Unraid ([Source](https://codeberg.org/HanSolo97/unraid-templates) AGPL-3.0) - [Cosmos](https://cosmos-cloud.io/proxy#cosmos-ui/market-listing/cosmos-cloud/KitchenOwl) ([Source](https://github.com/azukaar/cosmos-servapps-official/tree/master/servapps/Kitchenowl) AGPL-3.0) - TrueNAS SCALE ([Source](https://github.com/truecharts/charts/tree/master/charts/stable/kitchenowl) BSD-3-Clause) +- NixOS ([Source](https://cyberchaos.dev/kloenk/nix/) AGPL-3.0) diff --git a/docs/docs/self-hosting/ingredient_parsing.md b/docs/docs/self-hosting/ingredient_parsing.md index c0b38d04..4a82ab38 100644 --- a/docs/docs/self-hosting/ingredient_parsing.md +++ b/docs/docs/self-hosting/ingredient_parsing.md @@ -21,5 +21,4 @@ Ollama is a locally hosted LLM. You can also run this on a remote host (e.g. you To use Ollama you need to set the following environment variables: - `LLM_MODEL`: The model name prefixed with `ollama` (e.g. `ollama/llama3.1`) -- `OPENAI_API_KEY`: Your OpenAI API key - `LLM_API_URL`: The URL of the Ollama server (e.g. `http://localhost:11434`)