feat: prepare mi-fitness-mcp for first public release

Package the standalone Mi Fitness MCP with clearer public docs, release metadata, CI, and safer local repository hygiene so it is ready to publish without secrets or work identity leakage.

README.md

@@ -1,32 +1,76 @@
 # Mi Fitness MCP
 
-Отдельный MCP-сервер для `Mi Fitness`.
+MCP server for Mi Fitness data.
 
-Подтверждённые данные:
+This project provides a local SQLite-backed MCP server for Mi Fitness cloud data.
 
-- шаги
-- калории
-- пульс
-- вес и состав тела
+## Current data coverage
 
-## Установка
+Confirmed with the current cloud flow:
+
+- daily activity
+  - steps
+  - distance
+  - active calories
+- heart rate
+- body measurements
+  - weight
+  - BMI
+  - fat, water, bone, and muscle metrics
+  - visceral fat
+  - basal metabolism
+
+Not yet confirmed with the current Xiaomi cloud endpoint:
+
+- sleep
+- workouts
+
+## Install
 
 ```bash
 python -m venv .venv
 source .venv/bin/activate
-pip install -e "."
+pip install -e '.[dev]'
 ```
 
-## Команды
+## Setup
+
+You need:
+
+- `userId`
+- `passToken`
+
+Typical flow:
+
+1. Open `https://account.xiaomi.com`
+2. Sign in to your Xiaomi account
+3. Open browser DevTools
+4. Inspect cookies for `account.xiaomi.com`
+5. Copy `userId` and `passToken`
+
+Configure the server:
 
 ```bash
 mi-fitness-mcp setup --mode mi_fitness_cloud --user-id "<userId>" --pass-token "<passToken>" --region ru
 mi-fitness-mcp doctor
+```
+
+For local endpoint exploration there is also a probe script:
+
+```bash
+python probe_mifitness.py --user-id "<userId>" --pass-token "<passToken>"
+```
+
+## Use
+
+```bash
 mi-fitness-mcp sync --start-date 2025-04-01 --end-date 2025-05-31
 mi-fitness-mcp serve
 ```
 
-## Настройка Claude Desktop
+## MCP client config
+
+Example `Claude Desktop` config:
 
 ```json
 {
@@ -38,3 +82,48 @@ mi-fitness-mcp serve
   }
 }
 ```
+
+## Example prompts
+
+- `Show my daily activity for the last 14 days`
+- `How has my resting heart rate changed this month?`
+- `Summarize my latest body measurements`
+- `Sync my latest Mi Fitness data`
+
+## Commands
+
+```bash
+mi-fitness-mcp --help
+mi-fitness-mcp setup --help
+mi-fitness-mcp doctor
+mi-fitness-mcp sync --help
+mi-fitness-mcp serve
+```
+
+## Development
+
+```bash
+pytest
+python -m build
+```
+
+## Troubleshooting
+
+- `Connection: failed`
+  - verify `userId` and `passToken`
+  - verify region, usually `ru`
+- `Credentials not found`
+  - run `setup` again
+- `sync` returns no data
+  - try another date range
+  - verify that the data actually exists in Mi Fitness cloud
+
+## Security
+
+- `passToken` is stored via the system keyring
+- do not commit `.env`, local config files, or real credentials
+- rotate tokens if they were pasted into chats or shell history
+
+## Disclaimer
+
+This is an unofficial project and is not affiliated with Xiaomi.