Skip to content

Commit

Permalink
refactor: add more info to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Bruno committed Jan 26, 2024
1 parent d2d05d6 commit e7fce07
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 🚀 Network Speed Test API

This is a FastAPI application that measures network speed and provides the results via an API.
This is a FastAPI application that measures network speed and provides the results via an API. It contains a scheduler that runs every 10 minutes and measures the network speed. The results are stored in a log file at 23:59.

## 📚 API Documentation

Expand Down Expand Up @@ -33,6 +33,20 @@ uvicorn main:app --reload

The application will be available at `http://localhost:8000`.

## ❌ In case of errors with modules

If you get an error like this:

```bash
ModuleNotFoundError: No module named 'schedule'
```

You can install the module with the following command:

```bash
python3 -m pip install schedule
```

## 📝 API Usage

### Get Network Speed
Expand Down

0 comments on commit e7fce07

Please sign in to comment.