From ab91f2ca30ccd65db79a482adc49aba2a7bdf41c Mon Sep 17 00:00:00 2001 From: PresentKim Date: Mon, 25 Mar 2024 12:31:35 +0900 Subject: [PATCH] :memo: Update README.md to more descriptions --- README.md | 63 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 49 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 1fd5a49..3a8eb53 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,7 @@
-[![Poggit CI][poggit-ci-badge]][poggit-ci-url] -[![Poggit Version][poggit-version-badge]][poggit-release-url] -[![Poggit Downloads][poggit-downloads-badge]][poggit-release-url] +![Version][version-badge] [![Stars][stars-badge]][stars-url] [![License][license-badge]][license-url] @@ -18,58 +16,95 @@

An plugin that automatically corrects the case of commands! -[View in Poggit][poggit-ci-url] · [Report a bug][issues-url] · [Request a feature][issues-url] +[Contact to me][author-discord] · [Report a bug][issues-url] · [Request a feature][issues-url]

+ ## About The Project -![Project Preview][project-preview] The functionality of the plugin is very simple. If the case of the command is incorrect, it is automatically corrected. ex) `/Tp someone` => `/tp someone` -ex) `/SAY hello` => `/say hello` +ex) `/SAY hello` => `/say hello` + +## ----- ## Target software: + This plugin officially only works with [`Pocketmine-MP`](https://github.com/pmmp/PocketMine-MP/). +## + ----- -## Installation -1) Download `.phar` from [Poggit release][poggit-release-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 -> **All built versions [here][poggit-ci-url]** +1) Download plugin `.phar` releases +2) Move downloaded `.phar` file to server's **/plugins/** folder +3) Restart the server + +## ----- ## 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/IgnoreCase/IgnoreCase?style=for-the-badge + [poggit-version-badge]: https://poggit.pmmp.io/shield.api/IgnoreCase?style=for-the-badge + [poggit-downloads-badge]: https://poggit.pmmp.io/shield.dl.total/IgnoreCase?style=for-the-badge + +[version-badge]: https://img.shields.io/github/v/release/presentkim-pm/IgnoreCase?display_name=tag&style=for-the-badge&label=VERSION + +[release-badge]: https://img.shields.io/github/downloads/presentkim-pm/IgnoreCase/total?style=for-the-badge&label=GITHUB%20 + [stars-badge]: https://img.shields.io/github/stars/presentkim-pm/IgnoreCase.svg?style=for-the-badge + [license-badge]: https://img.shields.io/github/license/presentkim-pm/IgnoreCase.svg?style=for-the-badge [poggit-ci-url]: https://poggit.pmmp.io/ci/presentkim-pm/IgnoreCase/IgnoreCase + [poggit-release-url]: https://poggit.pmmp.io/p/IgnoreCase + [stars-url]: https://github.com/presentkim-pm/IgnoreCase/stargazers + [releases-url]: https://github.com/presentkim-pm/IgnoreCase/releases + [issues-url]: https://github.com/presentkim-pm/IgnoreCase/issues + [license-url]: https://github.com/presentkim-pm/IgnoreCase/blob/main/LICENSE [project-icon]: https://raw.githubusercontent.com/presentkim-pm/IgnoreCase/main/assets/icon.png -[project-preview]: https://raw.githubusercontent.com/presentkim-pm/IgnoreCase/main/project-preview.png + +[project-preview]: https://raw.githubusercontent.com/presentkim-pm/IgnoreCase/main/assets/preview.gif