Skip to content

Commit d97ea50

Browse files
Update app logo to 256x256 for build and revised readme file
1 parent e7b88de commit d97ea50

File tree

2 files changed

+25
-69
lines changed

2 files changed

+25
-69
lines changed

README.md

Lines changed: 25 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -5,39 +5,7 @@ A fast, powerful desktop application for scraping business data from Google Maps
55
![License](https://img.shields.io/badge/license-MIT-blue.svg)
66
![Version](https://img.shields.io/badge/version-1.0.0-green.svg)
77

8-
## ✨ Features
9-
10-
### 🚀 Dual Scraping Modes
11-
- **Single Mode**: Scrape businesses for one location
12-
- **Bulk Mode**: Process multiple locations via CSV or manual entry
13-
14-
### ⚡ Performance
15-
- **3 Speed Modes**: Normal, Fast, and Ultra-Fast
16-
- Smart scrolling with optimized wait times
17-
- Parallel email extraction
18-
19-
### 📊 Real-Time Tracking
20-
- Live elapsed time display
21-
- Estimated completion time (bulk mode)
22-
- Per-query status updates
23-
- Overall statistics dashboard
24-
25-
### 💾 Data Management
26-
- **Auto-save** results after scraping
27-
- **Full history** with data retention
28-
- **Resume capability** for interrupted sessions
29-
- **Click history items** to view their results
30-
- Export to CSV or JSON formats
31-
32-
### 🎯 Comprehensive Data
33-
- Business name and category
34-
- Address and phone number
35-
- Website links
36-
- Owner information
37-
- Ratings and review counts
38-
- Email addresses (optional)
39-
40-
## 📥 Installation
8+
## 📥 Installation / Download
419

4210
### Windows
4311
1. Download the latest release: `gscrape Setup 1.0.0.exe`
@@ -57,6 +25,21 @@ npm install
5725
npm start
5826
```
5927

28+
## ✨ Features
29+
30+
- **Dual Modes**: Single location or bulk CSV processing
31+
- **3 Speed Modes**: Normal, Fast, Ultra-Fast
32+
- **Real-Time Tracking**: Live progress, elapsed time, statistics
33+
- **Full History**: Auto-save with resume capability
34+
- **Comprehensive Data**: Name, address, phone, website, email, owner, ratings
35+
36+
### Data Extracted
37+
- Business name and category
38+
- Address and phone number
39+
- Website links and email addresses
40+
- Owner information
41+
- Ratings and review counts
42+
6043
## 🛠️ Building from Source
6144

6245
### Prerequisites
@@ -65,22 +48,13 @@ npm start
6548

6649
### Setup
6750
```bash
68-
# Clone the repository
6951
git clone https://github.com/testdeployrepeat/gscrape.git
7052
cd gscrape
71-
72-
# Install dependencies (downloads Chrome automatically)
73-
npm install
74-
75-
# Run in development
76-
npm start
77-
78-
# Build installer
79-
npm run build
53+
npm install # Downloads Chrome automatically
54+
npm start # Run in development
55+
npm run build # Build installer (output in dist/)
8056
```
8157

82-
The installer will be in the `dist/` folder.
83-
8458
## ⚙️ Configuration
8559

8660
### Speed Modes
@@ -89,10 +63,10 @@ The installer will be in the `dist/` folder.
8963
- **Ultra-Fast**: Maximum speed (may trigger rate limits)
9064

9165
### Options
92-
- **Extract Websites**: Visit each business page for accurate website links
93-
- **Extract Emails**: Scrape email addresses from business websites
66+
- **Extract Websites**: Visit each business page for accurate links
67+
- **Extract Emails**: Scrape email addresses from websites
9468
- **Headless Mode**: Run browser in background
95-
- **Auto-save**: Automatically export results after scraping
69+
- **Auto-save**: Automatically export results
9670

9771
## 📊 Data Storage
9872

@@ -103,44 +77,26 @@ C:\Users\{YourUsername}\AppData\Roaming\gscrape\data\
10377

10478
Your data survives app restarts, updates, and reinstallation.
10579

106-
## 🤝 Contributing
107-
108-
Contributions are welcome! Please feel free to submit a Pull Request.
109-
110-
1. Fork the repository
111-
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
112-
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
113-
4. Push to the branch (`git push origin feature/AmazingFeature`)
114-
5. Open a Pull Request
115-
11680
## 💖 Support the Project
11781

118-
If you find this tool helpful, consider supporting its development:
119-
82+
If you find this tool helpful:
12083
- **PayPal**: [paypal.me/josedeguia](https://paypal.me/josedeguia)
12184
- **Wise**: [wise.com/pay/me/joserobertoquimod](https://wise.com/pay/me/joserobertoquimod)
12285

12386
## 📝 License
12487

125-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
88+
MIT License - see [LICENSE](LICENSE) file for details.
12689

12790
## ⚠️ Disclaimer
12891

129-
This tool is for educational and research purposes only. Please respect Google's Terms of Service and use responsibly. The authors are not responsible for any misuse of this software.
92+
This tool is for educational and research purposes only. Please respect Google's Terms of Service and use responsibly.
13093

13194
## 📮 Contact
13295

13396
**Rob De Guia** - Creator & Maintainer
134-
13597
- GitHub: [@testdeployrepeat](https://github.com/testdeployrepeat)
13698
13799

138-
## 🙏 Acknowledgments
139-
140-
- Built with [Electron](https://www.electronjs.org/)
141-
- Powered by [Puppeteer](https://pptr.dev/)
142-
- Uses [puppeteer-extra-plugin-stealth](https://github.com/berstend/puppeteer-extra/tree/master/packages/puppeteer-extra-plugin-stealth)
143-
144100
---
145101

146102
Made with ❤️ by Rob De Guia

app-logo.png

401 KB
Loading

0 commit comments

Comments
 (0)