pawel/MacTorn
1
0
Fork 0
mirror of https://github.com/pawelorzech/MacTorn.git synced 2026-01-30 04:04:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Add API data usage section to README.

Browse source
This commit is contained in:
Paweł Orzech 2026-01-18 00:52:58 +00:00
parent 61235e78af
commit 3c53b046f8
No known key found for this signature in database
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -63,6 +63,21 @@ A native macOS menu bar app for monitoring your **Torn** game status.
- macOS 13.0 (Ventura) or later - macOS 13.0 (Ventura) or later
- Torn API Key with access to: basic, bars, cooldowns, travel, profile, events, messages, market - Torn API Key with access to: basic, bars, cooldowns, travel, profile, events, messages, market
## API Data Usage
In compliance with the [Torn API Terms of Service](https://www.torn.com/api.html), the following table shows which API selections MacTorn uses and why:
| Selection | Purpose |
|-----------|---------|
| `basic` | Player name, ID, basic info |
| `bars` | Energy, Nerve, Happy, Life bars |
| `cooldowns` | Drug, Medical, Booster cooldowns |
| `travel` | Travel status and destination |
| `profile` | Battle stats, faction info |
| `events` | Recent events feed |
| `messages` | Unread message count |
| `market` | Item watchlist prices |
## Configuration ## Configuration
### Refresh Interval ### Refresh Interval