summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authornasr <nsrddyn@gmail.com>2025-12-01 23:59:45 +0100
committernasr <nsrddyn@gmail.com>2025-12-01 23:59:45 +0100
commitc831347ba3e6fd336f3b386a53ffd402df68ac21 (patch)
treed54746f130749215c848763ab0214bbc9b9503c2 /README.md
parent501043f8fe143d9a3e478e1f73b1816aa40ae482 (diff)
refactor: readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 1 insertions, 14 deletions
diff --git a/README.md b/README.md
index 0e68dd5..65a7232 100644
--- a/README.md
+++ b/README.md
@@ -47,7 +47,7 @@ TODO: Explanation on how to run the tests
The server will start on `http://localhost:8080` with the following endpoints:
-- `GET /` - API status
+- `GET /platform` - API status
- `GET /cpu` - CPU performance metrics and stress testing
- `GET /ram` - RAM usage metrics and memory allocation tests
@@ -109,19 +109,6 @@ Torque is built using modern Scala functional programming patterns:
sbt compile
```
-### Creating a Fat JAR
-
-```bash
-sbt assembly
-```
-
-## Configuration
-
-Torque can be configured via environment variables:
-
-- `TORQUE_PORT` - HTTP server port (default: 8080)
-- `TORQUE_HOST` - Server host (default: localhost)
-
## API Documentation
### CPU Endpoint