Update README
This commit is contained in:
20
README.md
20
README.md
@@ -8,16 +8,16 @@ The status retrieval/ping server that powers the API for mcstatus.io. This repos
|
|||||||
|
|
||||||
If you do not know what you are doing, or think that the cache durations enforced on our official website are tolerable, I would highly recommend using the official API instead. It is much more reliable and reduces the complexity of hosting it yourself.
|
If you do not know what you are doing, or think that the cache durations enforced on our official website are tolerable, I would highly recommend using the official API instead. It is much more reliable and reduces the complexity of hosting it yourself.
|
||||||
|
|
||||||
## Official API Documentation
|
## API Documentation
|
||||||
|
|
||||||
https://mcstatus.io/docs
|
https://mcstatus.io/docs
|
||||||
|
|
||||||
## Requirements
|
## Prerequisites
|
||||||
|
|
||||||
- [Git](https://git-scm.com/)
|
- [Git](https://git-scm.com/)
|
||||||
- [Go](https://go.dev/)
|
- [Go](https://go.dev/)
|
||||||
- [Redis](https://redis.io/)
|
- [Redis](https://redis.io/) (optional)
|
||||||
- [GNU Make](https://www.gnu.org/software/make/) (*optional*)
|
- [GNU Make](https://www.gnu.org/software/make/) (optional)
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
@@ -25,18 +25,16 @@ https://mcstatus.io/docs
|
|||||||
- `git clone https://github.com/mcstatus-io/ping-server.git`
|
- `git clone https://github.com/mcstatus-io/ping-server.git`
|
||||||
2. Move the working directory into the folder
|
2. Move the working directory into the folder
|
||||||
- `cd ping-server`
|
- `cd ping-server`
|
||||||
3. Install all required dependencies
|
3. Build the executable
|
||||||
- `go get ...`
|
|
||||||
4. Build the executable
|
|
||||||
- Using GNU make
|
- Using GNU make
|
||||||
- `make`
|
- `make`
|
||||||
- Without GNU make
|
- Without GNU make
|
||||||
- `go build -o .\bin\main.exe .\src\*.go` (Windows)
|
- `go build -o .\bin\main.exe .\src\*.go` (Windows)
|
||||||
- `go build -o bin/main src/*.go` (Unix)
|
- `go build -o bin/main src/*.go` (Linux/macOS)
|
||||||
5. Copy the `config.example.yml` file to `config.yml` and edit the details
|
4. Copy the `config.example.yml` file to `config.yml` and edit the details
|
||||||
6. Start the API server
|
5. Start the API server
|
||||||
- `.\bin\main.exe` (Windows)
|
- `.\bin\main.exe` (Windows)
|
||||||
- `bin/main` (Unix)
|
- `bin/main` (Linux/macOS)
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user