Tidy up README
This commit is contained in:
parent
b8118a8f68
commit
1ebc102fb1
15
README.md
15
README.md
|
@ -5,7 +5,7 @@ Minecraft Server Invites [mc.gmem.ca](https://mc.gmem.ca)
|
||||||
|
|
||||||
![Homepage screenshot](homepage.png)
|
![Homepage screenshot](homepage.png)
|
||||||
|
|
||||||
_Looking for the frontend? See here: https://git.sr.ht/~gmem/minecraft-server-invites-frontend_
|
_Looking for the frontend? See here: [~gmem/minecraft-server-invites-frontend](https://git.sr.ht/~gmem/minecraft-server-invites-frontend)_
|
||||||
|
|
||||||
## About
|
## About
|
||||||
|
|
||||||
|
@ -17,10 +17,11 @@ migrated - I have no plans at this time to support non-migrated accounts, despit
|
||||||
about them) and send a command over RCON to your server to add them to the whitelist. It will then give them
|
about them) and send a command over RCON to your server to add them to the whitelist. It will then give them
|
||||||
the address to connect to the server.
|
the address to connect to the server.
|
||||||
|
|
||||||
This is currently hosted at [mc.gmem.ca](https://mc.gmem.ca) while being developed. It's currently free, and
|
This is currently hosted at [mc.gmem.ca](https://mc.gmem.ca) while being developed. It's free for the time being,
|
||||||
while I do want to eventually monetize this hosted version, you are more than welcome to host your own instance
|
and while I do want to eventually monetize this hosted version, you are more than welcome to either use the hosted
|
||||||
(this is actually recommended if you have the ability, since it allows you to keep RCON private). I do
|
version or host your own instance (this is actually recommended if you have the ability, since it allows you to
|
||||||
happily [accept donations](https://www.buymeacoffee.com/gmem) though!
|
keep RCON private). I do happily [accept donations](https://www.buymeacoffee.com/gmem) to keep running the public
|
||||||
|
hosted version!
|
||||||
|
|
||||||
*while the term "whitelist" is by and large being replaced in places, this is still the term Minecraft servers
|
*while the term "whitelist" is by and large being replaced in places, this is still the term Minecraft servers
|
||||||
utilise, and is therefore the term used in this application. Should it be changed, use of the term here will
|
utilise, and is therefore the term used in this application. Should it be changed, use of the term here will
|
||||||
|
@ -53,6 +54,8 @@ AZURE_OAUTH_CLIENT_SECRET_ID=<client secret id> # technically unused at the mome
|
||||||
```shell
|
```shell
|
||||||
# Docker
|
# Docker
|
||||||
docker run whitelistmanager
|
docker run whitelistmanager
|
||||||
# Non-docker
|
# Non-docker, built binary
|
||||||
|
./wlm
|
||||||
|
# Non-docker, non-built
|
||||||
go run ./...
|
go run ./...
|
||||||
```
|
```
|
Loading…
Reference in a new issue