update README

.github/workflows/publish.yml

@@ -23,6 +23,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install setuptools wheel twine
+          pip install -r hazm
       - name: Build and publish
         env:
           TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}

README.md

@@ -35,13 +35,24 @@ pip3 install Sansorchi
 
 ### usage
 
+- remove badwords
+
 ```python
+from sansorchi import Sansorchi
+
+sansorchi = Sansorchi()
+
+sansorchi.remove_bad_words("YOUR_TEXT")
+‍```
 
-from sansorchi import sansor
-print(sansor("YOUR_TEXT"))
+- check badwords
 
+```python
+sansorchi.is_bad_word("YOUR_TEXT")
 ```
 
+if yourtext has badword return True else return False
+
 ### Contributing
 
 See this [file](https://github.com/mmdbalkhi/Sansorchi/blob/main/CONTRIBUTING.md) to contribute

sansorchi/__init__.py

@@ -1,4 +1,4 @@
 """Sansorchi a package for remove swears word"""
 from sansorchi.sansorchi import Sansorchi  # noqa: E401
 
-__version__ = "5.0.0"
+__version__ = "5.0.1"