From 53250f35cc043bd84e9fab82b447638deda30246 Mon Sep 17 00:00:00 2001 From: Arthur Lu Date: Wed, 26 Jun 2024 06:46:31 +0000 Subject: [PATCH] fix readme tables --- README.md | 68 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 52 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 35b7f5e..f8939da 100644 --- a/README.md +++ b/README.md @@ -75,25 +75,61 @@ Backend handlers are used to interface with any number and type of backend data Each backend must implement the following methods: -||| -|-|-| -|openSession|opens a session to the backend by creating a session token| -|closeSession|closes a session to the backend| + + + + + + + + + +
openSessionopens a session to the backend by creating a session token
closeSessioncloses a session to the backend
Additionally, backends dealing with user data may also need to implement: -||| -|-|-| -|addUser|create a user| -|getUser|retrieve user data including membership| -|setUser|modify a user| -|delUser|delete a user| -|addGroup|create a group| -|getGroup|retrieve group data including members| -|setGroup|modify group data except membership| -|delGroup|delete group| -|addUserToGroup|add user to group as member| -|deluserFromGroup|remove user from group| + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
addUsercreate a user
getUserretrieve user data including membership
setUsermodify a user
delUserdelete a user
addGroupcreate a group
getGroupretrieve group data including members
setGroupmodify group data except membership
delGroupdelete group
addUserToGroupadd user to group as member
deluserFromGroupremove user from group
Not all user backends will necessarily implement all the methods fully. For example, backends which do not store group data may not need to implement the group related methods.