From 259ce297a7ca28b460c2f86972f6e8b59679dd36 Mon Sep 17 00:00:00 2001
From: RGBCube <78925721+RGBCube@users.noreply.github.com>
Date: Fri, 28 Jan 2022 20:14:03 +0300
Subject: [PATCH] Update README.md

---
 docs/README.md | 20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)

diff --git a/docs/README.md b/docs/README.md
index 9c6c172..f7e033a 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -2,9 +2,19 @@
 <!-- will be updated soon -->
 # *class* `json_wrapper.JsonWrapper(json_path: str)`
 ### Methods
-* *def* `set(key: str, value, *, pathmagic: (str, list) = "")`
-* *def* `get(key: str, *, default=None, pathmagic: (str, list) = "")`
-* *def* `all()`
-* *def* `rem(key: str, *, pathmagic: (str, list) = "")`
-* *def* `nuke(*, pathmagic: (str, list) = "")`
+* [*def* `set(key: str, value, *, pathmagic: (str, list) = "")`](https://github.com/RGBCube/json-wrapper/tree/main/docs#def-setkey-str-value--pathmagic-str-list--)
+* [*def* `get(key: str, *, default=None, pathmagic: (str, list) = "")`]() TODO
+* [*def* `all()`]() TODO
+* [*def* `rem(key: str, *, pathmagic: (str, list) = "")`]() TODO
+* [*def* `nuke(*, pathmagic: (str, list) = "")`]() TODO
 ## *def* `set(key: str, value, *, pathmagic: (str, list) = "")`
+Sets the key value pair in the json.
+
+If the pathmagic kwarg is given, (if str)it will split it by the +'s and make dicts inside dicts(or use existing ones) until the list ends. Then it will set the key value pair in the last dict.
+
+#### Args:
+* key `(str)`: The key for the key value pair.
+* value `(Any)`: The value for the key value pair.
+* pathmagic `(Union[str, List[str]], optional)`: The path to follow. Defaults to `""`.
+
+#### [Example Usage]() TODO