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.
List Operations
This section contains documentation for the list operations of ArmaDragonflyClient that allow for working with ordered collections of items.
Available Functions
- listAdd - Add an item to a list
- listGet - Get items from a list
- listLoad - Load a list from the database
- listRemove - Remove an item from a list
- listSet - Set an item in a list
Example Usage
// Add an item to a list
["myList", ["myItem"]] call dragonfly_db_fnc_listAdd;
// Set an item at a specific index
["myList", 0, [myNewValue]] call dragonfly_db_fnc_listSet;
// Get an item at a specific index
["myList", 0, "myFunction"] call dragonfly_db_fnc_listGet;
// Load all items from a list
["myList", "myFunction"] call dragonfly_db_fnc_listLoad;
// Remove an item at a specific index
["myList", 0] call dragonfly_db_fnc_listRemove;