Update Readme

Author: sumansaurabh

.gitignore

@@ -2,3 +2,6 @@
 __pycache__
 *.egg-info
 poetry.lock
+dist
+build
+.vscode

README.md

@@ -1,8 +1,6 @@
 The project is a fork from the original project - https://github.com/rr-/docstring_parser/
 
-Based on the provided document, here is a README outline for the Python package it describes:
-
----
+I have updated it based on use case for - https://www.snorkell.ai/
 
 # PyDocSmith
 
@@ -66,6 +64,13 @@ print(docstring_text)
 - **Parse From Object:** PyDocSmith can parse docstrings directly from Python objects, including classes and modules, incorporating attribute docstrings into the structured representation.
 - **Custom Rendering Styles:** Customize the rendering of docstrings with compact or detailed styles, and specify custom indentation for the generated docstring text.
 
+## Things that have been modified wrt to docstring_parser
+
+1. Better heuristics to detect docstring style
+2. Google Docstring has been modified to accommodate Notes, Examples
+3. Sometime GoogleDoc string doesn't have proper indentation specially when generated from LLMs like GPT or Mistral. PyDocSmith can fix those bad docstrings.
+4. Additional test-cases were added to accommodate a different style of GoogleDocstring
+
 ## Contributing
 
 Contributions are welcome! Please submit pull requests or report issues on the project's GitHub page.

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name="PyDocSmith",
-    version="0.1",
+    version="0.1.1",
     description="It parses and composes docstrings in Google, Numpydoc, ReST and Epydoc.",
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",