39 lines
1.9 KiB
Markdown
39 lines
1.9 KiB
Markdown
<img src="./assets/logo.webp" alt="Feather" width="200" align="right">
|
|
|
|
[![Discord](https://discord.com/api/guilds/827863713855176755/widget.png)](https://discord.gg/p9gzFE2bc6)
|
|
[![Download](https://img.shields.io/badge/Download-Releases-red.svg)](https://git.rainnny.club/Rainnny/Feather/releases)
|
|
[![Docs - Gitea](https://img.shields.io/badge/Wiki-Gitea-darkgreen.svg)](https://git.rainnny.club/Rainnny/Feather/wiki)
|
|
[![Docs - Javadocs](https://img.shields.io/badge/Wiki-Javadocs-purple.svg)](https://maven.rainnny.club/javadoc/public/me/braydon/Feather/1.0.0)
|
|
|
|
> [!IMPORTANT]
|
|
> This repository is a work-in-progress, if you have an issue, please create one <a href="https://git.rainnny.club/Rainnny/Feather/issues/new">here</a>
|
|
|
|
# Feather
|
|
An all-in-one plugin library to help Java developers make Bungeecord & Spigot plugins.
|
|
|
|
## Table of Contents
|
|
- [Features](#features)
|
|
- [Download](https://git.rainnny.club/Rainnny/Feather/releases)
|
|
- [Wiki](https://git.rainnny.club/Rainnny/Feather/wiki)
|
|
- [Javadocs](https://maven.rainnny.club/javadoc/public/me/braydon/Feather/1.0.0)
|
|
- [Support](#support)
|
|
- [Contributing](#contributing)
|
|
- [Building from Source](#building-from-source)
|
|
|
|
## Features
|
|
- TODO
|
|
|
|
## Stars
|
|
[![Star History Chart](https://api.star-history.com/svg?repos=Rainnny7/Feather&type=Timeline)](https://star-history.com/#Rainnny7/Feather&Timeline)
|
|
|
|
## Support
|
|
Looking for support? Join the [**Discord**](https://discord.gg/p9gzFE2bc6) or contact **rainnny7** on Discord.
|
|
|
|
## Contributing
|
|
1. Follow steps for [**building from source**](#building-from-source)
|
|
2. Make your changes
|
|
3. Make a PR with your changes, following [**these guidelines**](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit)
|
|
|
|
## Building from Source
|
|
1. **Clone this repository**: `git clone https://git.rainnny.club/Rainnny/Feather.git && cd Feather`
|
|
2. **Build the project**: `mvn package`, output is `./target` |