Skip to content

Commit 50fdf92

Browse files
authored
docs: improved main readme
1 parent 0acc62e commit 50fdf92

File tree

6 files changed

+105
-150
lines changed

6 files changed

+105
-150
lines changed

β€ŽCHANGELOG.MD

Lines changed: 0 additions & 6 deletions
This file was deleted.

β€ŽLICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 ScrapeGraphAI
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

β€ŽREADME.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# 🌐 ScrapeGraph AI SDKs
2+
3+
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
4+
[![Python SDK](https://img.shields.io/badge/Python_SDK-Latest-blue)](https://github.com/ScrapeGraphAI/scrapegraph-sdk/tree/main/scrapegraph-py)
5+
[![JavaScript SDK](https://img.shields.io/badge/JavaScript_SDK-Latest-yellow)](https://github.com/ScrapeGraphAI/scrapegraph-sdk/tree/main/scrapegraph-js)
6+
[![Documentation](https://img.shields.io/badge/Documentation-Latest-green)](https://scrapegraphai.com/docs)
7+
8+
Official SDKs for the ScrapeGraph AI API - Intelligent web scraping powered by AI. Extract structured data from any webpage with natural language prompts.
9+
10+
## πŸš€ Quick Links
11+
12+
- [Python SDK Documentation](scrapegraph-py/README.md)
13+
- [JavaScript SDK Documentation](scrapegraph-js/README.md)
14+
- [API Documentation](https://scrapegraphai.com/docs)
15+
- [Website](https://scrapegraphai.com)
16+
17+
## πŸ“¦ Installation
18+
19+
### Python
20+
```bash
21+
pip install scrapegraph-py
22+
```
23+
24+
### JavaScript
25+
```bash
26+
npm install scrapegraph-js
27+
```
28+
29+
## 🎯 Core Features
30+
31+
- πŸ€– **AI-Powered Extraction**: Use natural language to describe what data you want
32+
- πŸ“Š **Structured Output**: Get clean, structured data with optional schema validation
33+
- πŸ”„ **Multiple Formats**: Extract data as JSON, Markdown, or custom schemas
34+
- ⚑ **High Performance**: Concurrent processing and automatic retries
35+
- πŸ”’ **Enterprise Ready**: Production-grade security and rate limiting
36+
37+
## πŸ› οΈ Available Endpoints
38+
39+
### πŸ” SmartScraper
40+
Extract structured data from any webpage using natural language prompts.
41+
42+
### πŸ“ Markdownify
43+
Convert any webpage into clean, formatted markdown.
44+
45+
### πŸ’» LocalScraper
46+
Extract information from a local HTML file using AI.
47+
48+
49+
## 🌟 Key Benefits
50+
51+
- πŸ“ **Natural Language Queries**: No complex selectors or XPath needed
52+
- 🎯 **Precise Extraction**: AI understands context and structure
53+
- πŸ”„ **Adaptive Scraping**: Works with dynamic and static content
54+
- πŸ“Š **Schema Validation**: Ensure data consistency with Pydantic/TypeScript
55+
- ⚑ **Async Support**: Handle multiple requests efficiently
56+
57+
## πŸ’‘ Use Cases
58+
59+
- 🏒 **Business Intelligence**: Extract company information and contacts
60+
- πŸ“Š **Market Research**: Gather product data and pricing
61+
- πŸ“° **Content Aggregation**: Convert articles to structured formats
62+
- πŸ” **Data Mining**: Extract specific information from multiple sources
63+
- πŸ“± **App Integration**: Feed clean data into your applications
64+
65+
## πŸ“– Documentation
66+
67+
For detailed documentation and examples, visit:
68+
- [Python SDK Guide](scrapegraph-py/README.md)
69+
- [JavaScript SDK Guide](scrapegraph-js/README.md)
70+
- [API Documentation](https://scrapegraphai.com/docs)
71+
72+
## πŸ’¬ Support & Feedback
73+
74+
- πŸ“§ Email: [email protected]
75+
- πŸ’» GitHub Issues: [Create an issue](https://github.com/ScrapeGraphAI/scrapegraph-sdk/issues)
76+
- 🌟 Feature Requests: [Request a feature](https://github.com/ScrapeGraphAI/scrapegraph-sdk/issues/new)
77+
78+
## πŸ“„ License
79+
80+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
81+
82+
---
83+
84+
Made with ❀️ by [ScrapeGraph AI](https://scrapegraphai.com)

β€Žreadme.md

Lines changed: 0 additions & 137 deletions
This file was deleted.

β€Žscrapegraph-js/LICENSE

Lines changed: 0 additions & 7 deletions
This file was deleted.
File renamed without changes.

0 commit comments

Comments
Β (0)