Skip to content

Commit 7870224

Browse files
authored
Merge pull request #1 from cozymos/update-readme
Update readme
2 parents 82cd1ae + 2691e96 commit 7870224

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ npm install
5858

5959
**Create environment file**
6060

61-
Create your own `.env` file and add your API keys for local development. Vite exposes variables prefixed with `VITE_` to the browser app via `index.html`.
61+
Create your own `.env` file and add your API keys for local development. Vite exposes variables prefixed with `VITE_` to the browser app
6262

6363
```bash
6464
VITE_GOOGLE_MAPS_API_KEY=your_google_maps_api_key
@@ -67,11 +67,11 @@ VITE_OPENAI_API_KEY=your_openai_api_key
6767

6868
### "Bring your own key" approach
6969

70-
As an open-source project targeting technical users, this application is designed to run on user's keys. The user is responsible for:
70+
As an open-source project targeting technical users, this client-only web-app is designed to run on user's keys. The user is responsible for:
7171

72-
1. Creating their own Google Cloud project and API key (required).
72+
1. Creating their own Google Cloud project Maps API key (required), and OpenAI API key (optional)
7373
2. Securing their key by restricting it to their own domains (`localhost` for testing, their deployment domain for production).
74-
3. The costs associated with their usage.
74+
3. The costs associated with their usage, respecting Google Maps and OpenAI terms of service.
7575

7676
**Generate API keys**
7777

@@ -85,7 +85,7 @@ As an open-source project targeting technical users, this application is designe
8585
1. Visit the [OpenAI dashboard](https://platform.openai.com/api-keys).
8686
2. Create a new secret key and copy it for later use; it won't be shown again.
8787

88-
**Start the development server**
88+
**Start Vite development server**
8989

9090
```bash
9191
npm run dev
@@ -102,6 +102,8 @@ npm run dev
102102
**Start server proxy for MSFS "moving map**
103103

104104
- Install Python with UV and dependencies (see `pyproject.toml`)
105+
- Relies on the [Python‑SimConnect](https://github.com/odwdinc/Python-SimConnect) library
106+
- Run it alongside with MSFS on the same PC
105107

106108
```bash
107109
uv pip install .

0 commit comments

Comments
 (0)