Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ZacharyHampton committed Sep 18, 2023
1 parent 54af03c commit 29897b8
Showing 1 changed file with 15 additions and 19 deletions.
34 changes: 15 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,15 @@

**HomeHarvest** aims to be the top Python real estate scraping library.

## RoadMap
_**Under Consideration**: We're looking into the possibility of an Excel plugin to cater to a broader 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`
- `realtor.com`

## Listing Types

- `for_rent`
- `for_sale`
- `sold`

### Installation
## Installation

```bash
pip install --upgrade homeharvest
```

### Example Usage
## Example Usage
```
from homeharvest import scrape_property
Expand All @@ -35,3 +19,15 @@ properties = scrape_property(
)
print(properties)
```

### Site Name Options

- `zillow`
- `redfin`
- `realtor.com`

### Listing Types

- `for_rent`
- `for_sale`
- `sold`

0 comments on commit 29897b8

Please sign in to comment.