doc: Update example code and include additional .is_valid() usage (#7)

* update code to python and include add'l usage step * chore: Move `.is_valid()` to after basic intro * edit: Simplify sentence --------- Co-authored-by: Garrick Aden-Buie <[email protected]>
posit-dev · Jan 8, 2025 · 757c7cd · 757c7cd
1 parent 3706f24
commit 757c7cd
Showing 1 changed file with 11 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -22,11 +22,11 @@ pip install git+https://github.com/posit-dev/py-shiny-validate.git
 
 To add validation to your Shiny app, you need to:
 
-1.  Create an InputValidator object: `iv <- InputValidator`
+1.  Create an InputValidator object: `iv = InputValidator()`
 
 2.  Add one or more validation rules to the InputValidator: `iv.add_rule("title", check.required())`
 
-3.  Turn the validator on: `iv$enable()`
+3.  Turn the validator on: `iv.enable()`
 
 That's all you need to do to get validation messages to show up.
 
@@ -57,3 +57,12 @@ def server(input, output, session):
 
 app = App(app_ui, server)
 ```
+
+You can also use the `.is_valid()` method to ensure that the inputs are valid before rendering an output:
+
+```python
+@render.plot
+def plot():
+    req(iv.is_valid())
+    # Build and return a plot if the inputs are valid
+```