Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Annabella Proctor <nadairpro@gmail.com>
  • Loading branch information
wwwdotanna authored Apr 22, 2023
1 parent 8311b4c commit a1040fb
Showing 1 changed file with 32 additions and 43 deletions.
75 changes: 32 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,39 @@
# Decent Holograms
A lightweight yet very powerful hologram plugin with many features and configuration options.

**Links:**
- [SpigotMC (Download)](https://www.spigotmc.org/resources/96927/)
- [Discord (Support)](https://discord.decentsoftware.eu/)
- [Wiki (Documentation)](https://wiki.decentholograms.eu/)
<br/>
<p align="center">
<a href="https://github.com/Network-Name/holographics">
<img src="https://i.imgur.com/pJNdlAN.png" alt="Logo" width="80" height="80">
</a>

<h3 align="center">Holographics</h3>

<p align="center">
A lightweight yet very powerful hologram plugin with many features and configuration options. Reconfigured for developers.
<br/>
<br/>
<a href="https://github.com/Network-Name/holographics"><strong>Explore the docs »</strong></a>
<br/>
<br/>
</p>
</p>

![Downloads](https://img.shields.io/github/downloads/Network-Name/holographics/total) ![Contributors](https://img.shields.io/github/contributors/Network-Name/holographics?color=dark-green) ![Issues](https://img.shields.io/github/issues/Network-Name/holographics) ![License](https://img.shields.io/github/license/Network-Name/holographics)

## Table Of Contents
* [Backlinks](#backlinks)
* [Support](#support)
* [Limitations](#limitations)
* [Contributing](#contributing)
* [bStats](#bStats)

## Backlinks
- [Original's SpigotMC](https://www.spigotmc.org/resources/96927/)
- [Original's Support Discord)](https://discord.decentsoftware.eu/)
- [Original's Wiki Documentation](https://wiki.decentholograms.eu/)

## Support
We are mostly active on Discord so the best way to get support is joining our [Discord Server](https://discord.decentsoftware.eu). Also, it is okay to report bugs here on GitHub or in the 'Discussion' page on the [Spigot Page](https://decentholograms.eu) of Decent Holograms.

## Minecraft Limitations
## Limitations
- Text is always facing the player.
- Text size or font cannot be changed.
- Some entities make sounds. It only applies to a few entities like the Warden which makes this heartbeat sound.
Expand All @@ -18,40 +42,5 @@ We are mostly active on Discord so the best way to get support is joining our [D
## Contributing
Pull requests are welcome. But for major changes, please create an issue to discuss the changes first.

## API [![](https://jitpack.io/v/decentsoftware-eu/decentholograms.svg)](https://jitpack.io/#decentsoftware-eu/decentholograms)
How to get DecentHolograms API into your project:

Replace `VERSION` with the current version of DecentHolograms. (Latest release)

### Gradle:
```groovy
repositories {
maven { url 'https://jitpack.io' }
}
dependencies {
compileOnly 'com.github.decentsoftware-eu:decentholograms:VERSION'
}
```

### Maven:
```xml
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>

<dependencies>
<dependency>
<groupId>com.github.decentsoftware-eu</groupId>
<artifactId>decentholograms</artifactId>
<version>VERSION</version>
<scope>provided</scope>
</dependency>
</dependencies>
```

## bStats
[![](https://bstats.org/signatures/bukkit/DecentHolograms.svg)](https://bstats.org/plugin/bukkit/DecentHolograms)

0 comments on commit a1040fb

Please sign in to comment.