diff --git a/README.md b/README.md index 9dd1263..b15b07a 100644 --- a/README.md +++ b/README.md @@ -4,17 +4,19 @@ datastorage Helper mod to manage players data. All the mods can acces a single file (container) and easily have the data saved/loaded for them. +Usage +----- -Use: + local data = datastorage.get(id, ...) -local container = datastorage.get_container (mod_name, player) - returns the table for given mod and a player. - If container wasnt used before it will be created, otherwise it will contain all previously stored data. - The table can store any data. - - Player's containers will be saved to disk on player leave. - All the containers will be saved on server shutdown. - To force save all player's data, use: +Returns a reference to a data container. The id is normally a player name. +Following arguments are keys to recurse into, normally only one, a string +describing the type of data, is used. If the container doesn't exist it will +be created, otherwise it will contain all previously stored data. The table +can store any data. Player's containers will be saved to disk when the player +leaves, and all references to the player's data should be dropped. All of the +containers will be saved on server shutdown. To forcibly save a container's +data use: -datastorage.save_container (player) + datastorage.save(id)