Skip to content

Commit a6455d9

Browse files
VinciGit00claude
andcommitted
feat: expand installation docs and bump version to 0.1.1
Add npm/pnpm/yarn/bun install instructions, from-source setup guide, and updated demo assets. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 1d1350d commit a6455d9

4 files changed

Lines changed: 53 additions & 2 deletions

File tree

README.md

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,65 @@
44

55
Command-line interface for [ScrapeGraph AI](https://scrapegraphai.com) — AI-powered web scraping, data extraction, search, and crawling.
66

7-
### Install (npm)
7+
## Installation
8+
9+
### From npm (recommended)
10+
11+
Install globally to use `just-scrape` from anywhere:
812

913
```bash
1014
npm install -g just-scrape
1115
```
1216

17+
Or use it directly without installing via `npx`:
18+
19+
```bash
20+
npx just-scrape --help
21+
```
22+
23+
You can also install with other package managers:
24+
25+
```bash
26+
# pnpm
27+
pnpm add -g just-scrape
28+
29+
# yarn
30+
yarn global add just-scrape
31+
32+
# bun
33+
bun add -g just-scrape
34+
```
35+
1336
Package: [just-scrape](https://www.npmjs.com/package/just-scrape) on npm.
1437

38+
### From source (local development)
39+
40+
Requires [Bun](https://bun.sh) and Node.js 22+.
41+
42+
```bash
43+
# Clone the repository
44+
git clone https://github.com/ScrapeGraphAI/just-scrape.git
45+
cd just-scrape
46+
47+
# Install dependencies
48+
bun install
49+
50+
# Run directly from source (no build needed)
51+
bun run dev --help
52+
53+
# Or build and link globally
54+
bun run build
55+
npm link
56+
just-scrape --help
57+
```
58+
59+
### Verify installation
60+
61+
```bash
62+
just-scrape --help
63+
just-scrape validate # check your API key
64+
```
65+
1566
## Tech Stack
1667

1768
| Concern | Tool |

assets/demo.gif

-159 KB
Loading

assets/demo.mp4

627 KB
Binary file not shown.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "just-scrape",
3-
"version": "0.1.0",
3+
"version": "0.1.1",
44
"description": "ScrapeGraph AI CLI tool",
55
"type": "module",
66
"main": "dist/cli.mjs",

0 commit comments

Comments
 (0)