From c038b4b743dd72f462eb60beef87951545920fbb Mon Sep 17 00:00:00 2001
From: alexb <189858354+alexb-palisaderesearch@users.noreply.github.com>
Date: Tue, 23 Sep 2025 14:02:39 +0300
Subject: [PATCH] Add env hints

---
 .env.example | 25 ++++++++++++++++++-------
 README.md    | 13 +++++++------
 2 files changed, 25 insertions(+), 13 deletions(-)

diff --git a/.env.example b/.env.example
index bdba180..2d3383c 100644
--- a/.env.example
+++ b/.env.example
@@ -1,14 +1,25 @@
 # LOGFIRE_ENVIRONMENT=hostname-username
 
-LOGFIRE_READ_TOKEN=
-LOGFIRE_WRITE_TOKEN=
-# LOGFIRE_CONSOLE_VERBOSE=True
-# LOGFIRE_CONSOLE_MIN_LOG_LEVEL=debug
+# https://logfire-us.pydantic.dev/palisaderesearch/-/projects -> project settings -> API keys
+# LOGFIRE_WRITE_TOKEN= (required)
+# LOGFIRE_READ_TOKEN= (optional)
+LOGFIRE_CONSOLE_VERBOSE=True
+LOGFIRE_CONSOLE_MIN_LOG_LEVEL=debug
 
-LANGFUSE_SKIP=1
+LANGFUSE_HOST=https://us.cloud.langfuse.com
+# https://us.cloud.langfuse.com/ -> project settings -> API keys
 # LANGFUSE_SECRET_KEY=
 # LANGFUSE_PUBLIC_KEY=
-LANGFUSE_HOST=https://us.cloud.langfuse.com
+# LANGFUSE_SKIP=1 (fallback/opt-out of receipts)
 
-# GOOGLE_API_KEY=
+# https://platform.openai.com/settings/organization/api-keys
 # OPENAI_API_KEY=
+
+# https://platform.claude.com/settings/keys
+# ANTHROPIC_API_KEY=
+
+# https://aistudio.google.com/app/apikey
+# GEMINI_API_KEY=
+
+# https://openrouter.ai/settings/keys
+# OPENROUTER_API_KEY=
diff --git a/README.md b/README.md
index a9a87ef..2e3defb 100644
--- a/README.md
+++ b/README.md
@@ -9,9 +9,9 @@ A template repository implementing Palisade's [coding guide](https://www.notion.
 
 ## Development
 
-<details> 
+<details>
   <summary>Starting from the template repo</summary>
-  
+
 ```bash
 # Clone
 gh repo clone PalisadeResearch/template my-new-project -- -o template
@@ -28,8 +28,7 @@ gh repo create --private PalisadeResearch/my-new-project
 gh api -X PUT /orgs/PalisadeResearch/teams/global-team/repos/PalisadeResearch/my-new-project -f permission=push
 git remote add origin git@github.com:PalisadeResearch/my-new-project.git
 git push -u origin main
-
-````
+```
 
 </details>
 
@@ -63,7 +62,7 @@ echo 'source $HOME/.nix-profile/share/nix-direnv/direnvrc' >> ~/.config/direnv/d
 
 # Install pre-commit
 nix profile install nixpkgs#pre-commit
-````
+```
 
 If something goes wrong, cross-check your setup against this [GitHub Action](.github/workflows/setup-toolchain.yml).
 
@@ -71,7 +70,9 @@ If something goes wrong, cross-check your setup against this [GitHub Action](.gi
 
 ### Project setup
 
-After cloning the repository, run:
+After cloning the repository, copy `.env.example` to `.env` and fill in the keys.
+
+Then run:
 
 ```bash
 # allow loading environment from flake.nix, pyproject.toml, and .env