3.0.0

CHANGELOG.md

@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [3.0.0] - 2022-09-13
 
 - The user is no longer allowed to change the email.
 - From this version and up, this extension requires the Minecraft Plugin [OAuth](https://github.com/Neapovil/oauth) to allow user to authenticate.

README.md

@@ -2,6 +2,10 @@
 
 > A [Flarum](http://flarum.org) extension. Allow users to login with Minecraft.
 
+## Requirements
+
+You need a Minecraft server with [OAuth](https://github.com/Neapovil/oauth) plugin installed.
+
 ## Install
 
 ```sh
@@ -17,6 +21,22 @@ composer remove nearata/flarum-ext-auth-minecraft
 php flarum cache:clear
 ```
 
+## How to use
+
+You need to fill all the fields in Minecraft Auth admin settings page.
+
+### Minecraft Server IP
+
+The Minecraft server IP that is using the OAuth plugin.
+
+### API URL
+
+If for example you are running Flarum and the Minecraft Server on the same machine, you are free to use `http://localhost:4567/verify`. If the Minecraft Server is on a different machine, you need to update `localhost` with the public IP of that machine.
+
+### API Secret
+
+The API secret can be found in the `Plugins/OAuth/config.json` file.
+
 ## Links
 
 - [Packagist](https://packagist.org/packages/nearata/flarum-ext-auth-minecraft)

composer.json

@@ -35,7 +35,7 @@
             "category": "feature",
             "icon": {
                 "name": "fas fa-server",
-                "backgroundColor": "#04E762",
+                "backgroundColor": "#00AA00",
                 "color": "#fff"
             }
         }