Skip to content

Commit 25fb2d4

Browse files
committed
update README
1 parent 35cf41c commit 25fb2d4

1 file changed

Lines changed: 8 additions & 11 deletions

File tree

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# PWMP Server
2-
This crate contains the PixelWeather Messaging Protocol Server and CLI.
1+
# PixelWeather Messaging Protocol Server
2+
This is the server application for the PixelWeather Messaging Protocol, which is a custom protocol designed for communication between PixelWeather nodes. The server is responsible for handling incoming connections, processing requests, and managing the state of connected devices.
33

44
#### CI Stats
55
[![Run static analysis on commit](https://github.com/PixelWeatherProject/pwmp-server/actions/workflows/verify_commits.yml/badge.svg)](https://github.com/PixelWeatherProject/pwmp-server/actions/workflows/verify_commits.yml) | [![Release tagged versions](https://github.com/PixelWeatherProject/pwmp-server/actions/workflows/release.yml/badge.svg)](https://github.com/PixelWeatherProject/pwmp-server/actions/workflows/release.yml) | [![Build and push the Docker image](https://github.com/PixelWeatherProject/pwmp-server/actions/workflows/docker_build.yml/badge.svg)](https://github.com/PixelWeatherProject/pwmp-server/actions/workflows/docker_build.yml)
@@ -58,15 +58,12 @@ logging:
5858
erase_file_on_start: false
5959
```
6060
61-
## Database server
62-
Only PostgreSQL and SQLite are supported. It's recommended to use the latest version.
63-
64-
Compatibility has been verified with the following versions:
65-
- PostgreSQL
66-
- 16.x
67-
- 17.4
68-
- SQLite
69-
- 3.52.0
61+
## Database support
62+
| | **Supported** | **Tested version** |
63+
|----------------------|:-------------:|:------------------:|
64+
| PostgreSQL | ✅ | 16.x, 17.x |
65+
| SQLite | ✅ | 3.52.0 |
66+
| MySQL | ❌ | |
7067
7168
## Using as a service
7269
The CLI has a `service` subcommand, which allows managing a background service.

0 commit comments

Comments
 (0)