RGBCube/JsonWrapper
1
Fork 0
mirror of https://github.com/RGBCube/JsonWrapper synced 2025-07-27 11:47:45 +00:00
Code Issues Activity Actions

Update README.md

Browse source
This commit is contained in:
RGBCube 2022-01-12 21:58:15 +03:00 • committed by GitHub
parent c22c2a77dd
commit 6e7295262e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -1,10 +1,15 @@
# ClutterDB
Extremely simple JSON database which behaves like a dict.
This was made for ClutterBot (still in development).
# Usage
Clone [this](https://github.com/Clutter-Cluster/ClutterDB/blob/main/db.py) file into your project folder.
Add `from db import CluttterDB` to the top of your project.
# Docs
## `db.set(key: str, value)`
Sets the key to the value in the JSON.
## `db.get(key: str, default=None)`
## `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.all()`
Returns all the JSON data.
@ -16,7 +21,7 @@ Note that this will not do anything if the key isn't set in the JSON.
Deletes everything in the JSON.
Use with caution.
# Usage
# Examples
Code:
```python
from db import ClutterDB