From 62d6a1837bdbbe2867e60064ea6599cc170b86d1 Mon Sep 17 00:00:00 2001
From: Clem <20025949+Clem-Fern@users.noreply.github.com>
Date: Sat, 4 Feb 2023 23:47:16 +0100
Subject: [PATCH 1/2] Update README.md

---
 README.md | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 581db50..25b5d53 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,28 @@
 # LuckSecure
-Secure LuckPerm group with A2F through discord
+*This is a bungeecord plugin. Depends on [LuckPerms](https://github.com/LuckPerms/LuckPerms)*
+
+#### This plugin aims to increase security by adding a custom luckperms context named `lucksecure` . A user with a group/permission in need of the `authenticated` context will have to authenticate himself with a time-based one-time password (Google Authenticator/Microsoft Authenticator & etc...) .
+
+---
+
+### Ex. how to use :
+
+
+1. Add a permission to a user with the `authenticated` context (ex: `lpb user {your pseudo} permission set lsauth.cmd true lucksecure=authenticated` )
+
+2. Test the command `lsauth-status` -> You do not have permission to execute this command!
+
+3. As you have now a permission which needs the `authenticated` context to be active, you'll have to setup your TOTP. Use `/lsauth` to generate a TOTP key and QRCODE and import it in your favortie 2AF/TOTP app.
+
+4. Use `/lsauth {your 2af code}` to gained the `authenticated` context and gained your permission. 
+
+5. Test again the command `lsauth-status {your pseudo}` -> {your pseudo} 2AF OK.
+
+### Commands :
+
+Command name | Permission | Description
+--- | --- | ---
+lsauth | none | On the first use, it will generate a totp key and qrcode
+lsauth {code} | none | Use this command to authenticate yourself with your TOTP code
+lsauth-status {player} | lsauth.cmd | Display the authentication status
+lsauth-reset {player/uuid} | none | Reset the totp key of a player (Usable in the bungeecord console only)

From c10448e716885e3317ed496f7c5b2c5c674fe947 Mon Sep 17 00:00:00 2001
From: Clem <20025949+Clem-Fern@users.noreply.github.com>
Date: Sun, 5 Feb 2023 00:11:16 +0100
Subject: [PATCH 2/2] Update README.md

---
 README.md | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 25b5d53..d3f8e2b 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 # LuckSecure
 *This is a bungeecord plugin. Depends on [LuckPerms](https://github.com/LuckPerms/LuckPerms)*
 
-#### This plugin aims to increase security by adding a custom luckperms context named `lucksecure` . A user with a group/permission in need of the `authenticated` context will have to authenticate himself with a time-based one-time password (Google Authenticator/Microsoft Authenticator & etc...) .
+#### This plugin aims to increase security by adding a custom luckperms context named `lucksecure` . A user with a group/permission in need of the `authenticated` context will have to authenticate himself with a time-based one-time password (Google Authenticator/Microsoft Authenticator & etc...).
 
 ---
 
@@ -26,3 +26,15 @@ lsauth | none | On the first use, it will generate a totp key and qrcode
 lsauth {code} | none | Use this command to authenticate yourself with your TOTP code
 lsauth-status {player} | lsauth.cmd | Display the authentication status
 lsauth-reset {player/uuid} | none | Reset the totp key of a player (Usable in the bungeecord console only)
+
+
+### How to build :
+```
+git clone https://github.com/PumpMyKins/LuckSecure.git
+cd LuckSecure
+mvn package
+```
+
+### TODO
+- kick timer on join
+- custom totp key length