init

README.md

@@ -0,0 +1,61 @@
+# Torn User Activity Scraper
+
+This project is a web application that scrapes user activity data from the Torn API and displays the results. It includes features for starting and stopping the scraping process, viewing logs, and downloading results.
+
+## Features
+
+- Start and stop scraping user activity data
+- View real-time logs
+- Download data and log files
+- View scraping results and statistics
+
+## Requirements
+
+- Python 3.8+
+- Flask
+- Flask-Bootstrap
+- Flask-WTF
+- Pandas
+- Requests
+
+## Installation
+
+1. Clone the repository:
+
+```sh
+git clone https://github.com/yourusername/torn-user-activity-scraper.git
+cd torn-user-activity-scraper
+```
+
+2. Create a virtual environment and activate it:
+```sh
+python3 -m venv venv
+source venv/bin/activate
+```
+
+3. Install the required packages:
+```sh
+pip install -r requirements.txt
+```
+
+4. Set up your configuration file:
+Create a `config.ini` file in the root directory of the project by renaming `example_config.ini` with the following content:
+
+```ini
+[DEFAULT]
+SECRET_KEY = your_secret_key
+API_KEY = your_api_key
+```
+
+## Usage
+
+1. Run the Flask application:
+```sh
+flask run
+```
+
+2. Open your web browser and navigate to `http://127.0.0.1:5000/`.
+
+## License
+
+This project is licensed under the MIT License.