From 4cfe462401245e26208ef6e923430cbbdce0341f Mon Sep 17 00:00:00 2001
From: thorbjoernl <51087536+thorbjoernl@users.noreply.github.com>
Date: Fri, 26 Jul 2024 10:34:20 +0200
Subject: [PATCH] Update documentation

---
 src/aerovaldb/plugins.py | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/aerovaldb/plugins.py b/src/aerovaldb/plugins.py
index 75b5d60..c43f530 100644
--- a/src/aerovaldb/plugins.py
+++ b/src/aerovaldb/plugins.py
@@ -50,8 +50,9 @@ def open(resource, /, use_async: bool = False) -> AerovalDB:
 
     :param resource: the resource-name for the database. The resource can be
         - 'entrypoint:path', with path being the location where the database should be generated
-        - 'path', with path containing either an aerovaldb.cfg configuration
-        - or path being a json_files dabasase
+        (eg. 'json_files:.')
+        - 'path', with path containing either an aerovaldb.cfg (Not yet implemented) configuration
+        or path being a json_files dabasase (for example, '.' is equivalent to 'json_files:.')
     :param use_async : If true, aiofile will be used to read files, otherwise files will be read
         synchronously.
     :return: an implementation-object of AerovalDB openend to a location