feat: added documentation

This commit is contained in:
Hazel 2024-07-02 16:32:44 +02:00
parent adef56790f
commit 96bb1fce8e

View File

@ -1,3 +1,22 @@
# Json-Unescape
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"}'
```