Skip to content

Commit 2d56b54

Browse files
author
Encore
committed
misc: update scraped example data into README
1 parent 6143b14 commit 2d56b54

File tree

1 file changed

+58
-2
lines changed

1 file changed

+58
-2
lines changed

README.md

Lines changed: 58 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,64 @@ It collects data such as organization/user details, top languages, and repositor
2323
1. Set the `PERMALINK` & `WITH_REPOS` environment variable to the GitHub organization/user you want to scrape:
2424

2525
```bash
26-
env PERMALINK=ranbot-ai WITH_REPOS=true npx ts-node src/index.ts
27-
env PERMALINK=encoreshao WITH_REPOS=true npx ts-node src/index.ts
26+
➜ github-scraper git:(main) env PERMALINK=ranbot-ai WITH_REPOS=false npx ts-node src/index.ts
27+
// Organization Info with Repos: {
28+
name: 'RanBOT Lab',
29+
picImageURL: 'https://avatars.githubusercontent.com/u/85019129?s=200&v=4',
30+
description: 'RanBOT uses AI/ML to transform web content into structured data.',
31+
topLanguages: [ 'TypeScript', 'JavaScript', 'CSS' ],
32+
followers: 4,
33+
peopleCount: 1,
34+
website: 'https://ranbot.online',
35+
location: 'China',
36+
socialLinks: [
37+
'https://linkedin.com/company/ranbot-ai',
38+
'https://x.com/ranbotai',
39+
'https://www.tiktok.com/@ranbotai'
40+
]
41+
}
42+
```
43+
44+
```bash
45+
➜ github-scraper git:(main) env PERMALINK=encoreshao WITH_REPOS=false npx ts-node src/index.ts
46+
// User Info with Repos: {
47+
name: 'Encore Shao',
48+
nickname: 'encoreshao',
49+
picImageURL: 'https://avatars.githubusercontent.com/u/745929?v=4',
50+
followers: 26,
51+
following: 35,
52+
website: 'https://icmoc.com',
53+
location: 'Shanghai, China',
54+
currentCompany: 'Ekohe',
55+
position: 'Engineer Manager | Researcher',
56+
organizations: [
57+
{
58+
name: 'ekohe',
59+
link: '/ekohe',
60+
orgImageURL: 'https://avatars.githubusercontent.com/u/1390403?s=64&v=4'
61+
},
62+
{
63+
name: 'ranbot-ai',
64+
link: '/ranbot-ai',
65+
orgImageURL: 'https://avatars.githubusercontent.com/u/85019129?s=64&v=4'
66+
},
67+
{
68+
name: '',
69+
link: '/encoreshao?tab=overview&org=ranbot-ai',
70+
orgImageURL: 'https://avatars.githubusercontent.com/u/85019129?s=40&v=4'
71+
},
72+
{
73+
name: '',
74+
link: '/encoreshao?tab=overview&org=ekohe',
75+
orgImageURL: 'https://avatars.githubusercontent.com/u/1390403?s=40&v=4'
76+
},
77+
{
78+
name: '',
79+
link: '/encoreshao?tab=overview&org=linktr-ai',
80+
orgImageURL: 'https://avatars.githubusercontent.com/u/178542156?s=40&v=4'
81+
}
82+
]
83+
}
2884
```
2985

3086
## Features

0 commit comments

Comments
 (0)