Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add release information to README.MD #22

Merged
merged 1 commit into from
Oct 7, 2021
Merged

Add release information to README.MD #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.MD
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# MineEffect
[![License](https://img.shields.io/github/license/sh0ckr6/mineeffect?style=flat-square)](https://github.com/sh0ckR6/MineEffect/blob/master/LICENSE)
[![CI](https://img.shields.io/github/workflow/status/sh0ckr6/mineeffect/CI?logo=github&style=flat-square)](https://github.com/sh0ckR6/MineEffect/actions/workflows/ci.yml)
[![Latest Release](https://img.shields.io/github/v/release/sh0ckR6/mineeffect?style=flat-square)](https://github.com/sh0ckr6/mineeffect/releases/latest)
[![Total Downloads](https://img.shields.io/github/downloads/sh0ckr6/mineeffect/total?style=flat-square)](https://github.com/sh0ckr6/mineeffect/releases/latest)

[![Open Issues](https://img.shields.io/github/issues-raw/sh0ckR6/MineEffect?style=flat-square)](https://github.com/sh0ckR6/MineEffect/issues)
[![Open PRs](https://img.shields.io/github/issues-pr-raw/sh0ckr6/mineeffect?style=flat-square)](https://github.com/sh0ckR6/MineEffect/pulls)
Expand All @@ -9,4 +11,16 @@
## Overview
Mining can be a pain sometimes. It gets repetitive, and it's just not a fun part of the game. But what if you were to add random effects for every block you break?

Introducing MineEffect! Each block you mine will give you an entirely random effect. The more you mine, the more effects you get.
Introducing MineEffect! Each block you mine will give you an entirely random effect. The more you mine, the more effects you get.

## Download
You can download the latest version of **MineEffect** on the [GitHub Releases page](https://github.com/sh0ckr6/mineeffect/releases/latest)!

### Supported Versions
| Paper Version | Windows 10 | MacOS Big Sur (11.6) | Ubuntu 21.04 |
|-|-|-|-|
| Paper 1.17.1 | ✔ | ✔ | ✔ |
| Paper 1.16.x | ❌ | ❌ | ❌ |

### Installation
Install the plugin by dragging the downloaded `.jar` file into your server's `plugins` folder!