Skip to content

Commit 1efc243

Browse files
author
Soul Browser
committed
docs: Fix installation instructions - install from GitHub source
1 parent e5b05bd commit 1efc243

2 files changed

Lines changed: 50 additions & 5 deletions

File tree

INSTALL_LOCAL.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Soul Browser - Installation Guide
2+
3+
## Install from Source (Recommended)
4+
5+
Since Soul Browser is not yet published to PyPI, install directly from the repository:
6+
7+
### Option 1: Install from GitHub URL
8+
```bash
9+
pip install git+https://github.com/vikrant-project/soulbrowser.git
10+
```
11+
12+
### Option 2: Install from cloned repo
13+
```bash
14+
git clone https://github.com/vikrant-project/soulbrowser.git
15+
cd soulbrowser
16+
pip install -e .
17+
```
18+
19+
### With extras (optional features)
20+
```bash
21+
# From GitHub
22+
pip install "git+https://github.com/vikrant-project/soulbrowser.git#egg=soulbrowser[all]"
23+
24+
# From local clone
25+
pip install -e ".[all]"
26+
pip install -e ".[geoip]"
27+
pip install -e ".[web3]"
28+
pip install -e ".[ai]"
29+
```
30+
31+
## Verify Installation
32+
```bash
33+
python -c "from soulbrowser import launch; print('SoulBrowser installed successfully!')"
34+
```
35+
36+
## Quick Start
37+
```python
38+
from soulbrowser import launch
39+
40+
browser = launch()
41+
page = browser.new_page()
42+
page.goto("https://example.com")
43+
print(page.title())
44+
browser.close()
45+
```

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,15 +73,15 @@ Soul Browser is the most advanced privacy-focused browser automation tool, combi
7373

7474
```bash
7575
# Basic installation
76-
pip install soulbrowser
76+
pip install git+https://github.com/vikrant-project/soulbrowser.git
7777

7878
# With all features
79-
pip install soulbrowser[all]
79+
pip install git+https://github.com/vikrant-project/soulbrowser.git[all]
8080

8181
# Specific features
82-
pip install soulbrowser[geoip] # GeoIP for timezone/locale detection
83-
pip install soulbrowser[web3] # Web3/cryptocurrency features
84-
pip install soulbrowser[ai] # AI features
82+
pip install git+https://github.com/vikrant-project/soulbrowser.git[geoip] # GeoIP for timezone/locale detection
83+
pip install git+https://github.com/vikrant-project/soulbrowser.git[web3] # Web3/cryptocurrency features
84+
pip install git+https://github.com/vikrant-project/soulbrowser.git[ai] # AI features
8585
```
8686

8787
### Node.js

0 commit comments

Comments
 (0)