feat: added documentation

README.md

@@ -1,3 +1,22 @@
 # Json-Unescape
 
-Unescape json string, which is escaped for json. This is usually necessarry for webscraping.
+Unescape json string, which is escaped for json. This is usually necessarry for webscraping.
+
+## Installation
+
+```bash
+pip install json-unescape
+```
+
+## Usage
+
+```python
+>>> from json_unescape import escape_json, unescape_json
+
+>>> escape_json('{"foo": "bar,,,eee"}')
+'{"key": "{\\"foo\\": \\"bar,,,eee\\"}"}'
+
+>>> unescape_json(escape_json('{"key": "{\\"foo\\": \\"bar,,,eee\\"}"}'))
+'{"foo": "bar,,,eee"}'
+```
+

json_unescape/__init__.py

@@ -0,0 +1,10 @@
+import json
+
+
+def escape_json(json_str: str) -> str:
+    nested_object: dict = {"key": json_str}
+    return json.dumps(nested_object)
+
+def unescape_json(json_str: str) -> str:
+    nested_json_string: str = '{"key": ' + json_str + '}'
+    return json.loads(nested_json_string)["key"]

json_unescape/__main__.py

@@ -1,5 +0,0 @@
-from .__about__ import __name__, __version__
-
-
-def cli():
-    print(f"Running {__name__} version {__version__} from __main__.py")

pyproject.toml

@@ -12,9 +12,6 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 
-[project.scripts]
-json-unescape = "json_unescape.__main__:cli"
-
 [build-system]
 requires = ["hatchling", "hatch-requirements-txt"]
 build-backend = "hatchling.build"