From 260f0cee8615ac6eedc46922a5e7b4319214f8e4 Mon Sep 17 00:00:00 2001 From: Tayyab R <32965703+Ifera@users.noreply.github.com> Date: Fri, 6 Aug 2021 00:26:38 +0500 Subject: [PATCH] added a little setup guide and link to discord --- README.md | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d9feb30..1e38460 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# UpdateNotifier +# UpdateNotifier -| HitCount | License | -|:--:|:--:| -|[![HitCount](http://hits.dwyl.io/JackMD/UpdateNotifier.svg)](http://hits.dwyl.io/JackMD/UpdateNotifier)|[![GitHub license](https://img.shields.io/github/license/JackMD/UpdateNotifier.svg)](https://github.com/JackMD/UpdateNotifier/blob/master/LICENSE)| +| Discord | Poggit | License | +|:--:|:--:|:--:| +|[![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/urQt6ETgYu)|[![Poggit-CI](https://poggit.pmmp.io/ci.shield/ifera-mc/UpdateNotifier/UpdateNotifier)](https://poggit.pmmp.io/ci/ifera-mc/UpdateNotifier/UpdateNotifier)|[![GitHub license](https://img.shields.io/github/license/JackMD/UpdateNotifier.svg)](https://github.com/JackMD/UpdateNotifier/blob/master/LICENSE)| ### A handy virion for PocketMine-MP plugin developers that checks if a new release for a plugin is available on Poggit. If so then it notifies the user about the new release. @@ -23,10 +23,26 @@ JackMD\UpdateNotifier\UpdateNotifier::checkUpdate($pluginName, $pluginVersion); - For information regarding how to use a virion in a plugin please refer [here](https://poggit.github.io/support/virion.html). +### Poggit Setup + +Edit the `.poggit.yml` in your repository and set it up like shown below. + +```yml +--- +branches: +- master +projects: + PLUGIN_NAME: + libs: + - src: ifera-mc/UpdateNotifier/UpdateNotifier + version: ^2.1.0 +... +``` + ### Disclaimer This plugin is designed to be used only by PocketMine-MP developers who wish to provide their users with the info of when an update to the plugin is available. ### Credits: -- [Sandertv](https://github.com/Sandertv) for helping me with the code. I know you said that you didn't want any credits but it only seems fair by doing so. +- [Sandertv](https://github.com/Sandertv)