Skip to content

Commit

Permalink
added a little setup guide and link to discord
Browse files Browse the repository at this point in the history
  • Loading branch information
Ifera committed Aug 5, 2021
1 parent 813a44c commit 260f0ce
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions 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.

Expand All @@ -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)

4 comments on commit 260f0ce

@ragedps
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

installed this added to my server and it keeps crashing how can i get it to work i need an essentials plugin bad

@MrNinja008
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

installed this added to my server and it keeps crashing how can i get it to work i need an essentials plugin bad

This isn't a plugin this a virion

@ragedps
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you refer me to an essentials plugin with fly and all those things the one on poggit isn’t good or can I purchase one off you ?

@MrNinja008
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wdym isn't good? Use Blazin Fly And Essential PE

Please sign in to comment.