Skip to content

Commit

Permalink
📝 Update README.md to more descriptions
Browse files Browse the repository at this point in the history
PresentKim committed Mar 25, 2024
1 parent a8a43ad commit 6e45796
Showing 1 changed file with 49 additions and 11 deletions.
60 changes: 49 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- PROJECT BADGES -->
<div align="center">

[![Poggit CI][poggit-ci-badge]][poggit-ci-url]
![Version][version-badge]
[![Stars][stars-badge]][stars-url]
[![License][license-badge]][license-url]

@@ -14,7 +14,7 @@
<img src="https://raw.githubusercontent.com/presentkim-pm/HotPluginReload/main/assets/icon.png" alt="Logo" width="80" height="80">
<h3>HotPluginReload</h3>
<p align="center">
Automatically server shutdown the server when the plugins file is changed!
An plugin that automatically server shutdown the server when the plugins file is changed!

[View in Poggit][poggit-ci-url] · [Report a bug][issues-url] · [Request a feature][issues-url]

@@ -23,50 +23,88 @@


<!-- ABOUT THE PROJECT -->

## About The Project

Didn't it bother you to turn off the server every time you change the plugin codes?
At the very least, it was too much of a bother for me.
At the very least, it was too much of a bother for me.

Just use this plugin to automatically shutdown the server when the plugin file changes!
It also supports reconnecting for players!
It also supports reconnecting for players!
##

-----

## Target software:

This plugin officially only works with [`Pocketmine-MP`](https://github.com/pmmp/PocketMine-MP/).

##

-----

## Installation
1) Download `.phar` from [Poggit ci][poggit-ci-url] or [Github releases][releases-url]
2) Move downloaded `.phar` file to server's **/plugins/** folder
3) Restart the server
## Downloads

### Download from [Github Releases][releases-url]

[![Github Downloads][release-badge]][releases-url]

###

### Download from [Poggit Releases][poggit-release-url]

[![Poggit Downloads][poggit-downloads-badge]][poggit-release-url]

##

-----

## Downloads
> **All released versions [here][poggit-release-url]**
## Installation

1) Download plugin `.phar` releases
2) Move downloaded `.phar` file to server's **/plugins/** folder
3) Restart the server

> **All built versions [here][poggit-ci-url]**
##

-----

## License

Distributed under the **LGPL 3.0**. See [LICENSE][license-url] for more information

##

-----

[author-discord]: https://discordapp.com/users/345772340279508993

[poggit-ci-badge]: https://poggit.pmmp.io/ci.shield/presentkim-pm/HotPluginReload/HotPluginReload?style=for-the-badge

[poggit-version-badge]: https://poggit.pmmp.io/shield.api/HotPluginReload?style=for-the-badge

[poggit-downloads-badge]: https://poggit.pmmp.io/shield.dl.total/HotPluginReload?style=for-the-badge

[version-badge]: https://img.shields.io/github/v/release/presentkim-pm/HotPluginReload?display_name=tag&style=for-the-badge&label=VERSION

[release-badge]: https://img.shields.io/github/downloads/presentkim-pm/HotPluginReload/total?style=for-the-badge&label=GITHUB%20

[stars-badge]: https://img.shields.io/github/stars/presentkim-pm/HotPluginReload.svg?style=for-the-badge

[license-badge]: https://img.shields.io/github/license/presentkim-pm/HotPluginReload.svg?style=for-the-badge

[poggit-ci-url]: https://poggit.pmmp.io/ci/presentkim-pm/HotPluginReload/HotPluginReload

[poggit-release-url]: https://poggit.pmmp.io/p/HotPluginReload

[stars-url]: https://github.com/presentkim-pm/HotPluginReload/stargazers

[releases-url]: https://github.com/presentkim-pm/HotPluginReload/releases

[issues-url]: https://github.com/presentkim-pm/HotPluginReload/issues

[license-url]: https://github.com/presentkim-pm/HotPluginReload/blob/main/LICENSE

[project-icon]: https://raw.githubusercontent.com/presentkim-pm/HotPluginReload/main/assets/icon.png

[project-preview]: https://raw.githubusercontent.com/presentkim-pm/HotPluginReload/main/assets/preview.gif

0 comments on commit 6e45796

Please sign in to comment.