diff --git a/README.md b/README.md index a36abfb..acbdfe1 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,42 @@ myice mobile-login This will output the necessary information that you can add to your `myice.ini` file. +## web interface + +The tool includes a web interface that can be accessed by running the web API server: + +```shell +uv run fastapi run myice/webapi.py +``` + +Then open your browser at `http://localhost:8000`. The web interface allows you to: + +- Select between different configured accounts +- View upcoming games and practices +- See detailed information about events including player rosters + +The web API provides the following endpoints: + +- `/schedule` - Get the schedule for a specific account +- `/game/{game_id}` - Get details for a specific game +- `/accounts` - Get a list of available accounts +- `/health` - Health check endpoint + +All endpoints (except `/health`) require an Authorization header with a Bearer token. +For development purposes, you can use `abc` as the token. + +## mobile functions + +The tool includes several mobile API functions that interact with MyIce's +mobile API: + +- `myice mobile-login` - Authenticate and get authentication tokens +- `myice mobile` - Fetch game data using the mobile API +- `myice mobile-game {game_id}` - Get detailed information about a specific game + +These functions can be useful for debugging or when the regular web +interface is not available. + ## fetch schedule ```shell