dragonfly/docs/core/README.md
Jacob Schmidt c8d81ba3bb
All checks were successful
Build / Build (push) Successful in 39s
docs: Update README.md with detailed documentation
This commit significantly enhances the `README.md` file, providing comprehensive documentation for the ArmaDragonflyClient.

Key changes:

*   **Detailed Function Categories:** Categorized functions for better organization (Core, Basic Data Operations, Hash Operations, List Operations).
*   **Usage Examples:** Added clear and concise usage examples for basic operations, hash operations (context and ID-specific), and list operations.
*   **Function Documentation Structure:** Outlined the structure for individual function documentation.
*   **License Information:** Updated the license information.
2025-03-30 17:15:35 -05:00

895 B

Core Functions

This section contains documentation for the core functions of ArmaDragonflyClient that handle initialization, process management, and scheduling.

Available Functions

  • addTask - Add a task to the scheduler
  • handler - Handle callbacks from the extension
  • init - Initialize the database system
  • printAddonName - Print the addon name
  • processQueue - Process queued database operations
  • scheduler - Schedule database operations
  • test - Test the database connection

Example Usage

// Initialize the database
[] call dragonfly_db_fnc_init;

// Test the database connection
[] call dragonfly_db_fnc_test;