1
0
Fork 0
mirror of https://github.com/xHyroM/lighteco.git synced 2024-11-10 01:18:07 +01:00

docs: readme

This commit is contained in:
Jozef Steinhübl 2023-08-28 09:06:15 +02:00
parent 3758d0abcc
commit 85c876e87f
3 changed files with 27 additions and 0 deletions

1
.github/FUNDING.yml vendored Normal file
View file

@ -0,0 +1 @@
ko_fi: xhyrom

BIN
.github/lighteco.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

26
README.md Normal file
View file

@ -0,0 +1,26 @@
![lighteco thumbnail](.github/lighteco.png)
**LightEco** ⚡ is an incredibly fast, lightweight, and modular plugin that excels across multiple platforms. It's designed to optimize performance and provide a seamless experience.
## Features
- **Lightweight** - LightEco is designed to be as lightweight as possible, with minimal impact on your server's performance.
- **Fast** - LightEco is incredibly fast, and is designed to be as efficient as possible.
- **Modular** - LightEco is designed to be modular, allowing you to install only the features you need.
- **Cross-platform** - LightEco is designed to work across multiple platforms
- **Multi-currency** - LightEco supports creating your own currencies and using them in your server
- **Local and global currencies** - LightEco offers support for both local and global currencies, enabling you to create server-specific or proxy-wide currencies.
- **Storage** - LightEco offers support for multiple storage types.
- **Open-source** - LightEco is open-source, and is available on [GitHub](https://github.com/xHyroM/lightecp)
## Development
Monorepo structure:
- api: The API for LightEco
- bukkit: The Bukkit implementation for LightEco
- common: The common code for LightEco
- currency-money: The Money currency for LightEco w/ Vault support
## License
LightEco is licensed under the [Apache-2.0 License](./LICENSE).