diff --git a/README.md b/README.md index 532c993..181a921 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ If something is broken, contact **J. Schmidt92** or open a new issue on **[Gitea
-**For more information, [read the Docs.](docs)** +**For more information, [read the Docs.](docs/README.md)** **For Roadmap, [visit the project page.](https://gitea.innovativedevsolutions.org/IDSolutions/ramdb/projects)** _(WIP)_ diff --git a/docs/README.md b/docs/README.md index 3d95a9d..d04ec17 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,7 +6,7 @@ This documentation provides details on all functions available in `ArmaRAMDb`. T The functions are categorized by their purpose: -### Core Functions +### [Core Functions](core/README.md) - [init](core/init.md) - Initialize the database system - [handler](core/handler.md) - Handle callbacks from the extension - [processQueue](core/processQueue.md) - Process queued database operations @@ -15,7 +15,7 @@ The functions are categorized by their purpose: - [printAddonName](core/printAddonName.md) - Print the addon name - [test](core/test.md) - Test the database connection -### Basic Data Operations +### [Basic Data Operations](basic/README.md) - [get](basic/get.md) - Get a value from the database - [set](basic/set.md) - Set a value in the database - [delete](basic/delete.md) - Delete a value from the database @@ -23,7 +23,7 @@ The functions are categorized by their purpose: - [load](basic/load.md) - Load the database from disk - [fetch](basic/fetch.md) - Fetch a value from the database -### Hash Operations +### [Hash Operations](hash/README.md) - [hashDelete](hash/hashDelete.md) - Delete a hash - [hashDeleteId](hash/hashDeleteId.md) - Delete a hash for a specific ID - [hashGet](hash/hashGet.md) - Get a field from a hash @@ -37,7 +37,7 @@ The functions are categorized by their purpose: - [hashSetId](hash/hashSetId.md) - Set a field in a hash for a specific ID - [hashSetIdBulk](hash/hashSetIdBulk.md) - Set multiple fields in a hash for a specific ID in one operation -### List Operations +### [List Operations](list/README.md) - [listAdd](list/listAdd.md) - Add an item to a list - [listDelete](list/listDelete.md) - Delete a list - [listGet](list/listGet.md) - Get items from a list