rent-scraper 1.0.31 → 1.0.32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +22 -1
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -1,3 +1,24 @@
1
1
  # rent-scraper
2
2
 
3
- Scrape data from rental listings from the command line
3
+ CLI entry point. Wires together config setup, region ID generation, and scraping into a single command.
4
+
5
+ ## Usage
6
+
7
+ ```bash
8
+ # Run (production build)
9
+ pnpm run rent-scraper
10
+
11
+ # Run (dev, no build)
12
+ pnpm run rent-scraper:dev
13
+
14
+ # Or via npx (no install required)
15
+ npx rent-scraper
16
+ ```
17
+
18
+ ## What It Does
19
+
20
+ 1. Checks for an existing config file — runs the `create-config` wizard if none is found
21
+ 2. Validates the config and generates Zillow region IDs for any zip codes that don't have them yet
22
+ 3. Starts the scrape via `@rent-scraper/scrape-listings`
23
+
24
+ See the [root README](../../README.md) for full CLI flags and config options.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "rent-scraper",
3
- "version": "1.0.31",
3
+ "version": "1.0.32",
4
4
  "type": "module",
5
5
  "exports": {
6
6
  ".": {
@@ -27,11 +27,11 @@
27
27
  "dayjs": "^1.11.13",
28
28
  "minimist": "^1.2.8",
29
29
  "picocolors": "^1.1.1",
30
- "@rent-scraper/api": "1.0.31",
31
- "@rent-scraper/create-config": "1.0.31",
32
- "@rent-scraper/browser-server": "1.0.31",
33
- "@rent-scraper/utils": "1.0.31",
34
- "@rent-scraper/scrape-listings": "1.0.31"
30
+ "@rent-scraper/api": "1.0.32",
31
+ "@rent-scraper/browser-server": "1.0.32",
32
+ "@rent-scraper/scrape-listings": "1.0.32",
33
+ "@rent-scraper/utils": "1.0.32",
34
+ "@rent-scraper/create-config": "1.0.32"
35
35
  },
36
36
  "devDependencies": {
37
37
  "@types/minimist": "^1.2.5",