diff --git a/README.md b/README.md index 0141620..2d0309c 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ ## Documentation -Complete documentation is available in the **[Docs](docs/01%20Getting%20Started/A%29%20Home.md)** folder. +Complete documentation is available in the **[Docs](docs/01%29%20Getting%20Started/A%29%20Home.md)** folder. # Centralized Warehouse Management for Modern Minecraft Servers diff --git a/docs/01 Getting Started/A) Home.md b/docs/01) Getting Started/A) Home.md similarity index 83% rename from docs/01 Getting Started/A) Home.md rename to docs/01) Getting Started/A) Home.md index f2b35dd..564aa58 100644 --- a/docs/01 Getting Started/A) Home.md +++ b/docs/01) Getting Started/A) Home.md @@ -57,9 +57,9 @@ Complete documentation is available in the **docs** folder. ### Getting Started -- [Home](/truenas_admin/RS-Warehouse/src/branch/main/docs/01%20Getting%20Started/A%20Home.md) -- [Installation And Setup](/truenas_admin/RS-Warehouse/src/branch/main/docs/01%20Getting%20Started/B%20Installation%20And%20Setup.md) -- [Creating a Warehouse Chest](/truenas_admin/RS-Warehouse/src/branch/main/docs/01%20Getting%20Started/C%20Creating%20A%20Warehouse%20Chest.md) +- Home +- [Installation And Setup](01%20Getting%20Started/B%29%20Installation%20And%20Setup.md) +- [Creating a Warehouse Chest](01%20Getting%20Started/C%29%20Creating%20A%20Warehouse%20Chest.md) ### Using the Warehouse diff --git a/docs/01 Getting Started/B Installation And Setup.md b/docs/01) Getting Started/B) Installation And Setup.md similarity index 100% rename from docs/01 Getting Started/B Installation And Setup.md rename to docs/01) Getting Started/B) Installation And Setup.md diff --git a/docs/01 Getting Started/C Creating A Warehouse Chest.md b/docs/01) Getting Started/C) Creating A Warehouse Chest.md similarity index 100% rename from docs/01 Getting Started/C Creating A Warehouse Chest.md rename to docs/01) Getting Started/C) Creating A Warehouse Chest.md diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index f83fe67..0000000 --- a/docs/README.md +++ /dev/null @@ -1,86 +0,0 @@ -# RS-Warehouse - -

- -![Minecraft](https://img.shields.io/badge/Minecraft-1.21+-brightgreen) -![Platform](https://img.shields.io/badge/Platform-Paper-orange) -![Storage](https://img.shields.io/badge/Storage-SQLite-blue) -![Status](https://img.shields.io/badge/Status-Stable-brightgreen) -![Development](https://img.shields.io/badge/Development-Active-green) -![RS Ecosystem](https://img.shields.io/badge/RS-Ecosystem-purple) - -

- -# Centralized Warehouse Management for Modern Minecraft Servers - -RS-Warehouse is a high-performance Paper plugin that replaces traditional chest storage with a centralized warehouse system. - -Instead of managing hundreds of overflowing chests, players deposit items into a shared warehouse where everything is organized using categories and subcategories. The result is a cleaner, faster, and more scalable storage solution for servers of any size. - ---- - -## Features - -- 📦 Shared warehouse inventory -- 📂 Categories and subcategories -- 📥 One-click item deposits -- 📤 Simple item withdrawals -- 🆕 Automatic discovery of new materials -- 🛠️ Full in-game administration -- 💾 SQLite database -- 🚀 Optimized for Paper servers - ---- - -## Requirements - -- Paper 1.21+ -- Java 21+ - ---- - -## Installation - -1. Download the latest release from the **Releases** page. -2. Copy `RS-Warehouse.jar` into your server's `plugins` folder. -3. Start or restart your Paper server. -4. RS-Warehouse will automatically create: - - `plugins/RS-Warehouse/` - - `config.yml` - - `database.db` - ---- - -## Documentation - -Complete documentation is available in the **[Home](/truenas_admin/RS-Warehouse/src/branch/main/docs/01%20Getting%20Started/A%20Home.md)** folder. - -### Getting Started - - -- [Home](docs/01 Getting Started/A Home.md) -- [Installation & Setup](docs/01 Getting Started/B Installation And Setup.md) -- [Creating a Warehouse Chest](docs/01 Getting Started/C Creating A Warehouse Chest.md) - - -### Using the Warehouse - -- [Depositing Items] -- [Withdrawing Items] - -### Organization - -- [Categories] -- [Subcategories] - -### Administration - -- [Permissions] -- [Commands] -- [Configuration] - -### Reference - -- [FAQ] - ---- \ No newline at end of file