From 098e675bd9055bbb0a63959fffc0e5520805f46c Mon Sep 17 00:00:00 2001
From: effone <me@eff.one>
Date: Sat, 20 Jun 2020 17:30:44 +0530
Subject: [PATCH] Update Readme / Comment

Signed-off-by: effone <me@eff.one>
---
 README.md                        | 33 ++++++++++++++++++++++++++++++++
 upload/inc/plugins/promption.php |  3 +++
 2 files changed, 36 insertions(+)

diff --git a/README.md b/README.md
index e5267a0..ea80bc3 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,35 @@
 # Promption
 Instantly update profile options as you change.
+
+Compatibility:
+--
+MyBB 1.8.x
+PHP 7.1+
+
+Implemented Features:
+--
+Uses ajax to instantly update user options in UserCP
+
+Planned features:
+--
+Nil
+
+Installation:
+--
+Exactly same like any other plugins. Users need to upload the files inside `upload` folder of the package maintaining the already made structure using any FTP / WebDav and install / activate the plugin from ACP.
+
+Settings:
+--
+No setting implemented. Just activate and go.
+
+External Dependency
+--
+Nil
+
+Links:
+--
+Github Repo link:
+https://github.com/mybbgroup/promption
+
+Group Site Link:
+https://mybb.group/Thread-Promption
\ No newline at end of file
diff --git a/upload/inc/plugins/promption.php b/upload/inc/plugins/promption.php
index 1fcd42c..78d2db7 100644
--- a/upload/inc/plugins/promption.php
+++ b/upload/inc/plugins/promption.php
@@ -1,6 +1,9 @@
 <?php
 /**
  *
+ * @category   MyBB Plugin
+ * @package    Promption
+ * @author     effone <me@eff.one>
  */
 
 if (!defined('IN_MYBB')) {