Merge branch 'main' of https://github.com/aXenDeveloper/ips-number-of…

…-entries-chatbox into main

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Maciej (aXen) Piotr Balcerzak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,61 @@
-# ips-number-of-entries-chatbox
+# (aXen) Number of entries Chatbox Free
+Plugin displays users the number of their entries in Chatbox Free application.
+
+The plugin shows entries from the Chatbox Free app in:
+- Hovercard,
+- ProfileHeader,
+- Topics
+
+## 📖 Table of contents
+- [🏷️ Requirements](#requirements)
+- [🧰 Install](#install)
+- [🛠️ Update](#update)
+- [📷 Graphics](#graphics)
+- [🔌 Download from other sources](#download)
+
+<a name="requirements"></a>
+## 🏷️ Requirements
+<ul>
+  <li><a href="https://invisioncommunity.com/">IPS Community Suite</a>: 4.5 version</li>
+  <li><a href="https://invisioncommunity.com/files/file/7465-chatbox-free/">Chatbox Free</a></li>
+</ul>
+
+<a name="install"></a>
+## 🧰 Install
+<ol>
+  <li>
+    Go to: AdminCP -> System -> SITE FEATURES -> <b>Plugins</b>.<br />
+    <img src="https://axendev.net/github/plugins/admincp_select.png" alt="Install Plugin" />
+  </li>
+  <li>
+    Click on the link "<b>manual upload</b>".<br />
+    <img src="https://axendev.net/github/plugins/manual_upload.png" alt="Manual Upload" />
+  </li>
+  <li>Select file .xml from packet and click install button.</li>
+</ol>
+
+<a name="update"></a>
+## 🛠️ Update
+<ol>
+  <li>
+    Go to: AdminCP -> System -> SITE FEATURES -> <b>Plugins</b>.<br />
+    <img src="https://axendev.net/github/plugins/admincp_select.png" alt="Install Plugin" />
+  </li>
+  <li>
+    Search plugin and click "<b>Upload a new version</b>".<br />
+    <img src="https://axendev.net/github/plugins/new_version_upload.png" alt="Upload a new version" />
+  </li>
+  <li>Select file .xml from packet and click install button.</li>
+</ol>
+
+<a name="graphics"></a>
+## 📷 Graphics:
+<img src="https://github.com/aXenDeveloper/ips-number-of-entries-chatbox/blob/main/1.png?raw=true" alt="1" />
+<img src="https://github.com/aXenDeveloper/ips-number-of-entries-chatbox/blob/main/2.png?raw=true" alt="2" />
+<img src="https://github.com/aXenDeveloper/ips-number-of-entries-chatbox/blob/main/3.png?raw=true" alt="3" />
+
+<a name="download"></a>
+## 🔌 Download from other sources:
+- [invisioncommunity.com](https://invisioncommunity.com/files/file/8761-axen-number-of-entries-chatbox-free/),
+- [invisionize.pl](https://forum.invisionize.pl/files/file/767-axen-number-of-entries-chatbox-free/)
+<p style="font-color: red">The resources from the links above are updated on an ongoing basis if the administration approves the file.</p>