diff --git a/README.md b/README.md index a130ba9..3ca54e0 100644 --- a/README.md +++ b/README.md @@ -15,3 +15,34 @@ will be rendered as: ```html some_text here ``` + +## Usage + +### Install +You can install with pip: + +```bash +pip install sphinxcontrib-del-marker +``` + +### Configure +and add it to `sphinx conf.py`: + +```python +# conf.py +... +extensions = ["sphinxcontrib_del_marker"] +... +``` + +### Use + +with directive: +```rst +.. del:: lorem lorem lorem +``` + + +## Roadmap + +- [ ] using with sphinx `role` \ No newline at end of file