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.
54 lines
2.2 KiB
XML
54 lines
2.2 KiB
XML
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
|
|
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_dir_71f12be5768ca2af9c9f300d019944af" xml:lang="en-US">
|
|
<title>G:/ids/dragonfly/docs/basic Directory Reference</title>
|
|
<indexterm><primary>G:/ids/dragonfly/docs/basic Directory Reference</primary></indexterm>
|
|
<section>
|
|
<title>Detailed Description</title>
|
|
|
|
<para>This section contains documentation for the basic data operations of ArmaDragonflyClient that allow for simple key-value storage and retrieval.</para>
|
|
<section xml:id="_README.md_1autotoc_md37">
|
|
<title>Available Functions</title>
|
|
<para><itemizedlist>
|
|
<listitem>
|
|
<para><link linkend="_md__g_1_2ids_2dragonfly_2docs_2basic_2delete">delete</link> - Delete a value from the database</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md__g_1_2ids_2dragonfly_2docs_2basic_2fetch">fetch</link> - Fetch a value from the database</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md__g_1_2ids_2dragonfly_2docs_2basic_2get">get</link> - Get a value from the database</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md__g_1_2ids_2dragonfly_2docs_2basic_2save">save</link> - Save the database to disk</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md__g_1_2ids_2dragonfly_2docs_2basic_2set">set</link> - Set a value in the database</para>
|
|
</listitem></itemizedlist>
|
|
</para>
|
|
</section>
|
|
<section xml:id="_README.md_1autotoc_md38">
|
|
<title>Example Usage</title>
|
|
<para><literallayout><computeroutput>// Set a value
|
|
["myKey", [myValue]] call dragonfly_db_fnc_set;
|
|
|
|
// Get a value
|
|
["myKey", "myFunction"] call dragonfly_db_fnc_get;
|
|
|
|
// Delete a key
|
|
["myKey"] call dragonfly_db_fnc_delete;
|
|
|
|
// Save database to disk
|
|
[] call dragonfly_db_fnc_save;
|
|
</computeroutput></literallayout></para>
|
|
</section>
|
|
<section xml:id="_README.md_1autotoc_md39">
|
|
<title>Related Categories</title>
|
|
<para><itemizedlist>
|
|
<listitem>
|
|
<para>Core Functions</para>
|
|
</listitem><listitem>
|
|
<para>Hash Operations</para>
|
|
</listitem><listitem>
|
|
<para>List Operations </para>
|
|
</listitem></itemizedlist>
|
|
</para>
|
|
</section>
|
|
</section>
|
|
</section>
|