diff --git a/README.md b/README.md index 683cd63..af65f7b 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,18 @@ # ClutterDB -extremely simple JSON database which behaves like a dict -this was made for ClutterBot (still in development) +Extremely simple JSON database which behaves like a dict. +This was made for ClutterBot (still in development). # Docs ## `db.set(key: str, value)` Sets the key to the value in the JSON. ## `db.rem(key: str)` Removes the key and value pair from the JSON. + Note that this will not do anything if the key isn't set in the JSON. ## `db.get(key: str, default=None)` Returns the value of the key in the json, if the key isn't set in the json, it returns the default kwarg. ## `db.nuke()` Deletes everything in the JSON. + Use with caution. # Usage ```python