From 16dace0efcb098629e2a48f47f07ab52388b46a9 Mon Sep 17 00:00:00 2001
From: Tobi <tobi@jacobs.rocks>
Date: Thu, 21 Dec 2023 12:43:41 +0100
Subject: [PATCH] Finished README.md

---
 addons/storage/README.md | 58 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 57 insertions(+), 1 deletion(-)

diff --git a/addons/storage/README.md b/addons/storage/README.md
index 2598a5e..cf967ba 100644
--- a/addons/storage/README.md
+++ b/addons/storage/README.md
@@ -1 +1,57 @@
-# Godot_Storage_System
\ No newline at end of file
+# 2090s Storage System
+
+## Overview
+The File class is a storage utility for handling file operations with optional encryption in Godot Engine. It allows for the creation, reading, writing, updating, and deletion of file contents, with an emphasis on handling JSON-formatted data.
+
+## Features
+- **Data Storage**: Stores data in a dictionary format.
+- **Encryption**: Optional encryption for file contents using a secret key.
+- **Flexible File Handling**: Handles file creation, reading, and writing operations.
+- **JSON Format**: Parses and stores data in JSON format.
+
+## Usage
+
+### Initialization
+```gdscript
+var file = GStorage.File.new(file_path, open_file, secretkey="")
+```
+
+- **file_path**: The path where the file is located or will be created.
+- **open_file**: The name of the file to open or create.
+- **secretkey**: The encryption key for securing the file. If empty, no encryption will be set.
+
+
+### Methods
+Sets the data in the file dictionary and writes it to the file. Didnt overwrite the whole dictionary. Existing values are overwritten and new values are added
+
+```gdscript
+var file = GStorage.File.set_data(dict)
+```
+
+- **dict**: i.e. {"device_id": 1, ...}
+- **return**: null
+
+
+If you want to change a single value without passing a dictionary:
+```gdscript
+var file = GStorage.File.set_key(key, value)
+```
+
+- **key**: i.e. "device_id"
+- **value**: i.e. 1
+- **return**: value
+
+If you want to have all data as a dictionary:
+```gdscript
+var file = GStorage.File.get_all_data()
+```
+
+- **return**: dictionary
+
+
+If you want to delete a key:
+```gdscript
+var file = GStorage.File.delete_data()
+```
+
+- **return**: null