From df3519ae181dec11b1e1160b18560033e4e16214 Mon Sep 17 00:00:00 2001
From: Cullen Watson <cgwatson@smu.edu>
Date: Sun, 17 Sep 2023 15:10:21 -0500
Subject: [PATCH] docs: add example

---
 README.md | 31 +++++++++++++++++++++++++++----
 1 file changed, 27 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 7b288bb..233f38f 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,35 @@
-**HomeHarvest** aims to be the top Python real estate scraping library. 
+# HomeHarvest
+
+**HomeHarvest** aims to be the top Python real estate scraping library.
 
 ## RoadMap
 
-- Currently, supports scraping from **RedFin**
-- Coming soon: Support for **Zillow** and other real estate platforms
-- Under consideration: Excel plugin to attract a wider audience
+- **Supported Sites**: Currently, we support scraping from sites such as `Zillow` and `RedFin`.
+- **Output**: Provides the option to return the scraped data as a Pandas dataframe.
+- **Under Consideration**: We're looking into the possibility of an Excel plugin to cater to a broader audience.
+
+## Site Name Options
+
+- `zillow`
+- `redfin`
+
+## Listing Types
+
+- `for_rent`
+- `for_sale`
 
 ### Installation
 
 ```bash
 pip install --upgrade homeharvest
+```
+
+### Example Usage
+```
+from homeharvest import scrape_property
+
+properties = scrape_property(
+    location="85281", site_name="zillow", listing_type="for_rent"
+)
+print(properties)
+```