📄 docs: Add readmes

2026-07-08 07:56:16 -05:00
parent eb03d54b3d
commit ae96a9bab4
2 changed files with 81 additions and 0 deletions
@@ -0,0 +1,45 @@
+# Torn Training Tracker
+
+Userscript for Torn gym training pages that adds a floating progress panel for your active attribute.
+
+## Features
+
+- Detects current training attribute on Torn gym page.
+- Stores target values per attribute.
+- Tracks training gains over time.
+- Shows estimated trains remaining, days remaining, and ETA.
+- Keeps local history and preferences in browser storage.
+
+## Requirements
+
+- A userscript manager such as Tampermonkey or Violentmonkey.
+- Access to Torn gym pages matching:
+  - `https://www.torn.com/gym.php*`
+
+## Installation
+
+1. Open your userscript manager.
+2. Create a new script.
+3. Paste the contents of `torn-training-tracker.js`.
+4. Save and enable the script.
+
+## Usage
+
+1. Open Torn gym at `https://www.torn.com/gym.php`.
+2. Train normally.
+3. Use the floating tracker panel to set your target for the current attribute.
+4. Review projected trains, per-day pace, and ETA.
+
+## Data Storage
+
+This script stores data in `localStorage` with the following keys:
+
+- `tat.targets`
+- `tat.history`
+- `tat.prefs`
+
+Data remains local to your browser profile unless you export/sync browser storage externally.
+
+## Version
+
+Current userscript version in metadata: `0.1.0`.