diff --git a/README.md b/README.md index e69de29..8b94c3f 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,39 @@ +Minecraft Server Invites [mc.gmem.ca](https://mc.gmem.ca) +=== + +**Generate Discord-like invites for your Minecraft server** + +![Homepage screenshot](homepage.png) + +_Looking for the frontend? See here: https://git.sr.ht/~gmem/minecraft-server-invites-frontend_ + +## Building + +```shell +# Docker +docker build . -t whitelistmanager +# Non-docker +go build -o wlm -ldflags "-s -w" +``` + +## Running + +This project aims to be as dependency free as possible. The SQLite database will be automatically +created on first run. + +[You will need to generate the keys for the Microsoft OAuth flow by following this guide](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app). + +The keys can then be saved to environment variables as follows: + +```shell +AZURE_OAUTH_CLIENT_ID= +AZURE_OAUTH_CLIENT_SECRET= +AZURE_OAUTH_CLIENT_SECRET_ID= # technically unused at the moment +``` + +```shell +# Docker +docker run whitelistmanager +# Non-docker +go run ./... +``` \ No newline at end of file diff --git a/homepage.png b/homepage.png new file mode 100644 index 0000000..0caf9c8 Binary files /dev/null and b/homepage.png differ