Merge pull request #226 from coderzawad/main

A friendly and cozy Read Me

Author: ToberoCat

README.md

@@ -1,4 +1,7 @@
-![banner](https://github.com/ToberoCat/ImprovedFactions_new/blob/main/branding/banners/spigot-banner.png?raw=true)
+# ImprovedFactions
+
+![ImprovedFactions Banner](https://github.com/ToberoCat/ImprovedFactions_new/blob/main/branding/banners/spigot-banner.png?raw=true)
+
 <div align="center">
 
 [![ToberoCat - ImprovedFactions](https://img.shields.io/static/v1?label=ToberoCat&message=ImprovedFactions&color=%23FEDD58&logo=github)](https://github.com/ToberoCat/ImprovedFactions_new "Go to GitHub repo")
@@ -8,32 +11,90 @@
 [![issues - ImprovedFactions](https://img.shields.io/github/issues/ToberoCat/ImprovedFactions_new)](https://github.com/ToberoCat/ImprovedFactions_new/issues)
 [![SpigotMain - ImprovedFactions](https://img.shields.io/badge/Spigot-ImprovedFactions-orange)](https://www.spigotmc.org/resources/improved-factions.95617 "Spigot ImprovedFactions page")
 [![CodeFactor](https://www.codefactor.io/repository/github/toberocat/improvedfactions/badge)](https://www.codefactor.io/repository/github/toberocat/improvedfactions)
-<a href="https://www.paypal.com/donate/?hosted_button_id=BGB6QWR886Q6Y">
-    <img src="https://img.shields.io/badge/Donate-PayPal-green.svg?logo=paypal&style=flat-square" height="20" alt="Donate">
-</a>
-<a href="https://discord.gg/VmSbFNZejz">
-    <img src="https://img.shields.io/discord/819932760550014986.svg?logo=discord&colorB=7289DA&style=flat-square" height="20" alt="Discord chat">
-</a>
+[![Donate - PayPal](https://img.shields.io/badge/Donate-PayPal-green.svg?logo=paypal&style=flat-square)](https://www.paypal.com/donate/?hosted_button_id=BGB6QWR886Q6Y)
+[![Discord](https://img.shields.io/discord/819932760550014986.svg?logo=discord&colorB=7289DA&style=flat-square)](https://discord.gg/VmSbFNZejz)
+
 </div>
 
-## Documentation
+## Table of Contents
+- [About](#about)
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Configuration](#configuration)
+- [Documentation](https://github.com/ToberoCat/ImprovedFactions/tree/main/docs)
+- [Contributing](#contributing)
+- [Support](#support)
+- [License](#license)
 
-<div align="center">
+## About
 
-[![view - Documentation](https://img.shields.io/badge/view-Documentation-blue?style=for-the-badge)](https://github.com/ToberoCat/ImprovedFactions_new/wiki "Go to project documentation")
+ImprovedFactions is a lightweight and high-performance Minecraft faction plugin. It offers a user-friendly experience with features that can be downloaded directly from Minecraft, enhancing server gameplay and community interaction.
 
-</div>
+## Features
 
-## About
+- **Performance Optimized**: Designed for efficiency, ensuring smooth gameplay even on busy servers.
+- **User-Friendly**: Intuitive commands and interfaces for players of all experience levels.
+- **Customizable**: Extensive configuration options to tailor the faction experience to your server's needs.
+- **Minecraft Integration**: Unique features downloadable directly through Minecraft for seamless user experience.
+- **Regular Updates**: Continual improvements and new features to keep your faction gameplay fresh and exciting.
+
+## Installation
+
+1. Download the latest version of ImprovedFactions from the [Spigot page](https://www.spigotmc.org/resources/improved-factions.95617) or [GitHub releases](https://github.com/ToberoCat/ImprovedFactions_new/releases/).
+2. Place the downloaded `.jar` file in your server's `plugins` folder.
+3. Restart your server.
+4. The plugin will generate default configuration files, which you can then customize.
+
+## Usage
+
+- `/f help` - View all available faction commands
+- `/f create <name>` - Create a new faction
+- `/f join <faction>` - Join an existing faction
+- `/f claim` - Claim land for your faction
+
+For a full list of commands and their usage, please refer to our [documentation](#documentation).
+
+## Configuration
+
+The main configuration file is located at `plugins/ImprovedFactions/config.yml`. Here you can adjust various settings such as:
 
-Improved factions is a lightweight and performant minecraft faction plugin. It supports features downloadable from
-Minecraft directly for more user friendlienes
+- Faction creation costs
+- Claim limits
+- Power systems
+- And much more!
 
-## Contributors
+Detailed configuration instructions can be found in our [wiki](https://github.com/ToberoCat/ImprovedFactions/tree/main/docs).
 
-Check [CONTRIBUTORS.md](CONTRIBUTORS.md) to see a list of all people who contributed to this project
+## Contributing
 
-## Others
+We welcome contributions from the community! If you'd like to contribute, please:
 
-### Bstat
-https://bstats.org/plugin/bukkit/ImprovedFactions/14810
+1. Fork the repository
+2. Create a new branch for your feature
+3. Commit your changes
+4. Push to the branch
+5. Create a new Pull Request
+
+For more information, see our [CONTRIBUTING.md](CONTRIBUTING.md) file.
+
+## Support
+
+- For bug reports and feature requests, please use our [GitHub Issues](https://github.com/ToberoCat/ImprovedFactions_new/issues).
+- Join our [Discord server](https://discord.gg/VmSbFNZejz) for community support and discussions.
+
+## License
+
+ImprovedFactions is released under the [MIT License](LICENSE).
+
+---
+
+<div align="center">
+
+Made with ❤️ by [ToberoCat](https://github.com/ToberoCat)
+
+Check [CONTRIBUTORS.md](CONTRIBUTORS.md) to see a list of all people who contributed to this project.
+
+[![Bstats](https://img.shields.io/badge/View-Bstats-blue?style=for-the-badge)](https://bstats.org/plugin/bukkit/ImprovedFactions/14810)
+
+</div>