update docs (#2)

* update docs

* add desc

Author: adhami3310

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "ruff-format"
-version = "0.5.0"
+version = "0.5.1"
 edition = "2024"
 license = "MIT"
 readme = "README.md"

Cargo.toml

@@ -15,17 +15,26 @@ pip install ruff-format
 ## Usage
 
 ```python
-from ruff_format import format_string, is_valid_syntax
+from ruff_format import format_string, is_valid_syntax, parse_code
 
 code = """
 def hello(  x,y,   z  ):
     print( x+y+z )
 """
 
+# Check if code has valid syntax
 assert is_valid_syntax(code)
 
+# Parse code (raises RuntimeError on syntax errors)
+parse_code(code)
+
+# Format code (default line width: 80)
 formatted = format_string(code)
 print(formatted)
+
+# Format with a custom line width
+formatted = format_string(code, line_width=120)
+print(formatted)
 ```
 
 ## Development

README.md

@@ -4,6 +4,7 @@ build-backend = "maturin"
 
 [project]
 name = "ruff-format"
+description = "Python bindings for the Ruff code formatter, built with Rust and PyO3."
 requires-python = ">=3.8"
 license = { text = "MIT" }
 classifiers = [

pyproject.toml

@@ -18,7 +18,7 @@ def is_valid_syntax(code: str) -> bool:
         True if the code has valid syntax, False otherwise.
     """
 
-def format_string(code: str, *, line_width: int) -> str:
+def format_string(code: str, *, line_width: int = 80) -> str:
     """Format a Python code string using Ruff.
 
     Args: