Feather/README.md

39 lines
1.9 KiB
Markdown
Raw Permalink Normal View History

2023-12-11 19:36:22 -08:00
<img src="./assets/logo.webp" alt="Feather" width="200" align="right">
2023-12-11 19:34:12 -08:00
[![Discord](https://discord.com/api/guilds/827863713855176755/widget.png)](https://discord.gg/p9gzFE2bc6)
2023-12-14 23:33:33 -08:00
[![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)
2023-12-11 19:36:22 -08:00
[![Docs - Javadocs](https://img.shields.io/badge/Wiki-Javadocs-purple.svg)](https://maven.rainnny.club/javadoc/public/me/braydon/Feather/1.0.0)
2023-12-11 19:34:12 -08:00
2023-12-14 23:40:09 -08:00
> [!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>
2023-12-11 21:20:35 -08:00
2023-12-11 19:34:12 -08:00
# 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)
2023-12-14 23:48:32 -08:00
- [Wiki](https://git.rainnny.club/Rainnny/Feather/wiki)
- [Javadocs](https://maven.rainnny.club/javadoc/public/me/braydon/Feather/1.0.0)
2023-12-11 19:34:12 -08:00
- [Support](#support)
- [Contributing](#contributing)
- [Building from Source](#building-from-source)
## Features
2023-12-11 21:18:29 -08:00
- TODO
2023-12-11 19:34:12 -08:00
2023-12-11 20:26:30 -08:00
## Stars
[![Star History Chart](https://api.star-history.com/svg?repos=Rainnny7/Feather&type=Timeline)](https://star-history.com/#Rainnny7/Feather&Timeline)
2023-12-11 19:34:12 -08:00
## 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`