diff --git a/README.md b/README.md index 363df20..275b186 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,32 @@
+> [!NOTE] +> Support for other mod loaders is not planned. PRs implementing such support will not be accepted, please fork this project instead. + +> [!WARNING] +> This mod does not provide support for standard permission systems, and by default only verifies permissions by operator status (i.e. commands can only be run by operators). + +## Supported versions + +| Version | Support level | +| ------- | ------------- | +| 1.20.1 | ✅ Fully supported | +| * | ❌ Not supported | + ## Installing -Download the latest release from the releases tab or go to the [latest release directly](https://code.lilyvex.dev/lily/oauth-fabric/releases/latest), then put it in your Fabric server's `mods` directory. +Download the latest release from the releases tab or go to the [latest release directly](https://code.lilyvex.dev/lily/oauth-fabric/releases/latest), you may optionally choose to build from source, then put it in your Fabric server's `mods` directory. + +## Usage + +On initial load, this mod will create a commented configuration file. Edit the created file to contain the correct credentials for your OAuth provider, then restart the server. + +Players who are not registered will be kicked on join and given a link to the OAuth provider, where they can login to register for the server. + +Each new login with create a new session which will expire after a set period of time (usually defined by your OAuth provider). + +Use the `/oauth` command to see a list of all available commands. ## Building from source @@ -30,4 +53,4 @@ gradlew.bat build ## Contributing -Fork this repository and create a branch for your changes, then create a pull request for the `main` branch with a "why", "what", and "how" to explain your changes. \ No newline at end of file +Fork this repository and create a branch for your changes, then create a pull request for the `dev` branch with a "why", "what", and "how" to explain your changes.