c8d81ba3bb
All checks were successful
Build / Build (push) Successful in 39s
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.
29 lines
895 B
Markdown
29 lines
895 B
Markdown
# Core Functions
|
|
|
|
This section contains documentation for the core functions of ArmaDragonflyClient that handle initialization, process management, and scheduling.
|
|
|
|
## Available Functions
|
|
|
|
- [addTask](addTask.md) - Add a task to the scheduler
|
|
- [handler](handler.md) - Handle callbacks from the extension
|
|
- [init](init.md) - Initialize the database system
|
|
- [printAddonName](printAddonName.md) - Print the addon name
|
|
- [processQueue](processQueue.md) - Process queued database operations
|
|
- [scheduler](scheduler.md) - Schedule database operations
|
|
- [test](test.md) - Test the database connection
|
|
|
|
## Example Usage
|
|
|
|
```sqf
|
|
// Initialize the database
|
|
[] call dragonfly_db_fnc_init;
|
|
|
|
// Test the database connection
|
|
[] call dragonfly_db_fnc_test;
|
|
```
|
|
|
|
## Related Categories
|
|
|
|
- [Basic Data Operations](../basic/README.md)
|
|
- [Hash Operations](../hash/README.md)
|
|
- [List Operations](../list/README.md) |