Skip to content

Commit

Permalink
📝 Update README.md to more descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
PresentKim committed Mar 25, 2024
1 parent 5d8ed7a commit 03b1a42
Showing 1 changed file with 28 additions and 11 deletions.
39 changes: 28 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
<!-- PROJECT BADGES -->
<div align="center">

[![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]

Expand All @@ -18,7 +16,7 @@
<p align="center">
An plugin that automatically link resource packs to cdn urls!

[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]

</p>
</div>
Expand Down Expand Up @@ -69,41 +67,58 @@ remove_extension: false
> If you want to set up a separate CDN url for each resource pack,
> use [alvin's 'Remote Resource Pack'](https://github.com/alvin-pm-pl/RemoteResourcePack)

##

-----

## Target software:

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

##

-----

## Installation
## Downloads

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

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

##

-----

## Downloads
## Installation

> **All released versions [here][poggit-release-url]**
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/ResourcePackCdn/ResourcePackCdn?style=for-the-badge

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

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

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

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

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

[license-badge]: https://img.shields.io/github/license/presentkim-pm/ResourcePackCdn.svg?style=for-the-badge
Expand All @@ -121,3 +136,5 @@ Distributed under the **LGPL 3.0**. See [LICENSE][license-url] for more informat
[license-url]: https://github.com/presentkim-pm/ResourcePackCdn/blob/main/LICENSE

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

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

0 comments on commit 03b1a42

Please sign in to comment.