diff --git a/README.md b/README.md new file mode 100644 index 0000000..81e2d66 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# OpenGSQ Master Server Search API + +This is an application that provides an API for searching game servers. The application supports the following games: BeamMP, Factorio, Palworld, and Scum. + +Try now: https://master-server.opengsq.com + +## Usage + +The application provides the following endpoints: + +- `/beammp/search?host=&port=` +- `/factorio/search?host=&port=` +- `/palworld/search?host=&port=` +- `/scum/search?host=&port=` + +Replace `` and `` with the host and port of the game server you want to search. + +## Error Handling + +The application will return a 400 error if the 'host' and 'port' parameters are not provided or if the 'port' parameter is not an integer. If no result is found, the application will return a 404 error. + +## License + +This project is licensed under the MIT License.