Skip to content

Commit b1059da

Browse files
loreyclaude
andcommitted
docs: improve README use cases and CLI examples
- Replace use cases table with simple icon list - Add real-world CLI examples with actual output - Show webpage scraping pipeline (curl | grep | socials) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 65915e8 commit b1059da

1 file changed

Lines changed: 14 additions & 15 deletions

File tree

README.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,11 @@ You have a list of URLs from a scrape, a CSV export, or email signatures.
1212
Some of them are social media profiles.
1313
Socials finds them and gives you structured data to work with.
1414

15-
| | |
16-
|---|---|
17-
| :mag: **Extract** | Pull social profiles from scraped pages or contact lists |
18-
| :white_check_mark: **Validate** | Check if URLs are recognized social profiles |
19-
| :arrows_counterclockwise: **Normalize** | Get consistent usernames from messy URL variations |
20-
| :card_file_box: **Categorize** | Group URLs by platform or entity type |
21-
| :robot: **Automate** | Batch process URL files via CLI |
15+
:mag: **Extract** social profiles from scraped pages or contact lists
16+
:white_check_mark: **Validate** URLs as recognized social profiles
17+
:arrows_counterclockwise: **Normalize** messy URL variations to consistent usernames
18+
:card_file_box: **Categorize** URLs by platform or entity type
19+
:robot: **Automate** batch processing via CLI
2220

2321
## Installation
2422

@@ -161,14 +159,15 @@ Usage: socials [OPTIONS] COMMAND [ARGS]...
161159
Examples:
162160

163161
```bash
164-
# Check a single URL
165-
socials check https://github.com/lorey
166-
167-
# Extract from a file
168-
socials extract urls.txt
169-
170-
# Pipe from another command
171-
cat links.txt | socials extract
162+
# Find all social links on a webpage
163+
$ curl -s https://karllorey.com | grep -oE 'https?://[^"]+' | socials extract
164+
linkedin https://www.linkedin.com/in/karllorey
165+
github https://github.com/lorey
166+
instagram https://www.instagram.com/karllorey
167+
168+
# Check what platform a URL belongs to
169+
$ socials check https://github.com/lorey
170+
github
172171
```
173172

174173
## Documentation

0 commit comments

Comments
 (0)