Update README.md

This commit is contained in:
Michael Beck 2025-02-22 16:04:30 +00:00
parent 5e98a0ba47
commit 94bda1dfaa

View File

@ -1,8 +1,12 @@
# Torn User Activity Tracker
A web based user per faction activity tracker for the text-based online RPG [torn.com](https://torn.com).
> [!WARNING]
> **Development is still in its early stages; do not put it to productive use!**
I am by no means a pro in python or anything I used here - so don't expect the code to run perfectly...
## Features
Multiple users control a single activity tracker using Torn's API.
@ -30,9 +34,9 @@ Multiple users control a single activity tracker using Torn's API.
- Flask-WTF
- Pandas
- Requests
- Redis
- Celery
- uWSGI
- Redis
Redis currently has to run locally, but this will be changed in the future. See file tasks.py:
@ -59,7 +63,7 @@ def get_redis():
1. Clone the repository:
```bash
git clone <repository-url>
git clone https://git.mbeck.cologne/mischbeck/Torn.com-ActivityTracker.git
cd TornActivityTracker
```
@ -103,7 +107,7 @@ docker-compose up -d --build
1. Clone the repository:
```sh
git clone https://github.com/MichaelB7/TornActivityTracker.git
git clone https://git.mbeck.cologne/mischbeck/Torn.com-ActivityTracker.git
cd TornActivityTracker
```