Skip to content

Commit

Permalink
docs: Update
Browse files Browse the repository at this point in the history
  • Loading branch information
TomBursch committed Sep 13, 2024
1 parent d6699cb commit acede49
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 2 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions docs/docs/self-hosting/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
1 change: 0 additions & 1 deletion docs/docs/self-hosting/ingredient_parsing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`)

0 comments on commit acede49

Please sign in to comment.