Update README.md

README.md

@@ -55,7 +55,7 @@ widget:
     interested and anyone basical e may be applyind reaching the browing
     approach were
 - medical course audio transcription
-inference: True
+inference: False
 pipeline_tag: text2text-generation
 language:
 - en
@@ -73,6 +73,36 @@ This model is a fine-tuned version of [facebook/bart-base](https://huggingface.c
 
 You can find other grammar-synthesis models by [searching for the grammar synthesis tag](https://huggingface.co/models?other=grammar%20synthesis)
 
+## Basic Usage Example
+
+### Installation
+
+First, make sure you have the `transformers` package installed. You can install it using pip:
+
+```
+pip install -U transformers
+```
+
+### Usage
+
+```python
+from transformers import pipeline
+
+# Initialize the text-generation pipeline for text correction
+corrector = pipeline("text2text-generation", "pszemraj/bart-base-grammar-synthesis")
+
+# Example text to correct
+raw_text = "The toweris 324 met (1,063 ft) tall, about height as .An 81-storey building, and biggest longest structure paris. Is square, measuring 125 metres (410 ft) on each side. During its constructiothe eiffel tower surpassed the washington monument to become the tallest man-made structure in the world, a title it held for 41 yearsuntilthe chryslerbuilding in new york city was finished in 1930. It was the first structure to goat a height of 300 metres. Due 2 the addition ofa brdcasting aerial at the t0pp of the twr in 1957, it now taller than  chrysler building 5.2 metres (17 ft). Exxxcluding transmitters,  eiffel tower is  2ndd tallest ree-standing structure in france after millau viaduct."
+
+# Correct the text using the text-generation pipeline
+corrected_text = corrector(raw_text)[0]["generated_text"]
+
+# Print the corrected text
+print(corrected_text)
+```
+
+This example demonstrates how to use the text-generation pipeline to correct the grammar in a given text. The `corrector` pipeline is initialized with the "pszemraj/bart-base-grammar-synthesis" model, which is designed for grammar correction. The `corrector` pipeline takes the raw text as input and returns the corrected text. Make sure to install the required dependencies and models before running the code.
+
 
 ## Intended uses & limitations