Skip to content

Commit c3132da

Browse files
authored
Merge pull request #9 from kisusu115/docs/readme
Docs/readme
2 parents f931019 + 2bcf962 commit c3132da

2 files changed

Lines changed: 98 additions & 14 deletions

File tree

.github/workflows/contributors.yml

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Update Contributors
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: write
11+
12+
jobs:
13+
update-contributors:
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- name: Checkout
18+
uses: actions/checkout@v4
19+
20+
- name: Build contributors HTML
21+
id: build
22+
uses: actions/github-script@v7
23+
with:
24+
script: |
25+
const owner = context.repo.owner;
26+
const repo = context.repo.repo;
27+
28+
const contributors = await github.paginate(github.rest.repos.listContributors, {
29+
owner,
30+
repo,
31+
per_page: 100,
32+
});
33+
34+
const sorted = contributors
35+
.filter((c) => c.type === 'User')
36+
.sort((a, b) => b.contributions - a.contributions)
37+
.slice(0, 30);
38+
39+
const html = sorted
40+
.map(
41+
(c) => `<a href="${c.html_url}" title="${c.login}"><img src="${c.avatar_url}" alt="${c.login}" width="64" height="64" style="border-radius: 50%;" /></a>`
42+
)
43+
.join('\n');
44+
45+
core.setOutput('html', html);
46+
47+
- name: Update README contributors block
48+
env:
49+
CONTRIBUTORS_HTML: ${{ steps.build.outputs.html }}
50+
run: |
51+
node -e "const fs=require('fs'); const path='README.md'; const start='<!-- CONTRIBUTORS:START -->'; const end='<!-- CONTRIBUTORS:END -->'; const s=fs.readFileSync(path,'utf8'); const a=s.indexOf(start); const b=s.indexOf(end); if(a===-1||b===-1||b<a){throw new Error('Contributors markers not found in README.md');} const before=s.slice(0,a+start.length); const after=s.slice(b); const block='\\n\\n'+process.env.CONTRIBUTORS_HTML+'\\n\\n'; fs.writeFileSync(path, before+block+after);"
52+
53+
- name: Commit and push if changed
54+
run: |
55+
if git diff --quiet README.md; then
56+
echo "No changes to commit"
57+
exit 0
58+
fi
59+
60+
git config user.name "github-actions[bot]"
61+
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
62+
git add README.md
63+
git commit -m "docs: update contributors list"
64+
git push

README.md

Lines changed: 34 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
[AI·SW마에스트로](https://www.swmaestro.ai) 멘토링/특강 일정을 사이드패널에서 한눈에 관리하는 크롬 확장프로그램입니다.
44

5-
![MentoryTime 스크린샷](screenshots/screenshot-combined.png)
5+
![MentoryTime 스크린샷](https://github.com/kisusu115/mentory-time/blob/main/screenshots/screenshot-combined.png?raw=1)
66

77
## 주요 기능
88

99
### 전체 강의
1010

11-
![전체 강의](screenshots/screenshot-all-lectures.png)
11+
![전체 강의](https://github.com/kisusu115/mentory-time/blob/main/screenshots/%EC%A0%84%EC%B2%B4%20%EA%B0%95%EC%9D%98.png?raw=1)
1212

1313
- 날짜별 전체 멘토링/특강 목록 조회
1414
- 상태(접수중/마감), 카테고리(멘토특강/자유멘토링), 시간대별 필터링
@@ -18,7 +18,7 @@
1818

1919
### 접수 목록
2020

21-
![접수 목록](screenshots/screenshot-list.png)
21+
![접수 목록](https://github.com/kisusu115/mentory-time/blob/main/screenshots/%EC%A0%91%EC%88%98%20%EB%AA%A9%EB%A1%9D.png?raw=1)
2222

2323
- 내 접수내역을 강의날짜/시간 기준 정렬
2424
- 접수완료/접수취소 필터 토글, 과거 기록 포함 토글
@@ -28,7 +28,7 @@
2828

2929
### 주간 시간표
3030

31-
![시간표](screenshots/screenshot-timetable.png)
31+
![시간표](https://github.com/kisusu115/mentory-time/blob/main/screenshots/%EC%8B%9C%EA%B0%84%ED%91%9C.png?raw=1)
3232

3333
- 30분 단위 슬롯, 겹침 수에 따라 색상 구분 (초록/주황/빨강)
3434
- 슬롯 클릭 시 해당 시간대 강좌 목록 팝오버 (장소 정보 포함)
@@ -69,6 +69,7 @@
6969
5. **압축해제된 확장 프로그램을 로드합니다** 클릭 후 `dist/` 폴더 선택
7070

7171
> `/init`이 수행하는 작업:
72+
>
7273
> - `pnpm install` — 의존성 설치
7374
> - `.git/info/exclude` 세팅 — Claude 전용 파일(`/samples`, `/.claude/plans` 등) 등록 (`.gitignore` 대신 사용하여 `@` 파일 검색 가능하게 유지)
7475
> - `samples/` HTML 파일 준비 안내 — 파서 검증용 HTML 4개 파일이 필요하며, 없으면 저장 방법을 안내
@@ -86,7 +87,6 @@ Manifest V3 · React 18 · Vite · CRXJS · TypeScript · Tailwind CSS · Zustan
8687

8788
---
8889

89-
9090
## 개인정보처리방침
9191

9292
MentoryTime은 사용자의 개인정보를 수집하지 않습니다.
@@ -101,15 +101,35 @@ MentoryTime은 사용자의 개인정보를 수집하지 않습니다.
101101

102102
### 접근 권한
103103

104-
| 권한 | 사용 목적 |
105-
| ------------------------ | ------------------------------------------------ |
106-
| `sidePanel` | 사이드 패널 UI 표시 |
107-
| `storage` | 접수내역/강의 목록/설정 로컬 캐싱 |
108-
| `scripting` | swmaestro.ai 탭에서 인증된 세션으로 데이터 fetch |
109-
| `identity` | 구글 캘린더 OAuth 인증 |
110-
| `https://swmaestro.ai/*` | 접수내역/강의 목록 데이터 fetch |
111-
| `https://api.notion.com/*` | Notion 데이터베이스 연동 |
104+
| 권한 | 사용 목적 |
105+
| -------------------------- | ------------------------------------------------ |
106+
| `sidePanel` | 사이드 패널 UI 표시 |
107+
| `storage` | 접수내역/강의 목록/설정 로컬 캐싱 |
108+
| `scripting` | swmaestro.ai 탭에서 인증된 세션으로 데이터 fetch |
109+
| `identity` | 구글 캘린더 OAuth 인증 |
110+
| `https://swmaestro.ai/*` | 접수내역/강의 목록 데이터 fetch |
111+
| `https://api.notion.com/*` | Notion 데이터베이스 연동 |
112112

113113
### 문의
114114

115-
문의사항은 [GitHub Issues](https://github.com/leegwichan/mentory-time/issues)를 통해 남겨주세요.
115+
문의사항은 [GitHub Issues](https://github.com/kisusu115/mentory-time/issues)를 통해 남겨주세요.
116+
117+
## Contributors
118+
119+
<!-- CONTRIBUTORS:START -->
120+
121+
<a href="https://github.com/kisusu115" title="kisusu115"><img src="https://avatars.githubusercontent.com/u/119473141?v=4" alt="kisusu115" width="64" height="64" style="border-radius: 50%;" /></a>
122+
<a href="https://github.com/leegwichan" title="leegwichan"><img src="https://avatars.githubusercontent.com/u/44027393?v=4" alt="leegwichan" width="64" height="64" style="border-radius: 50%;" /></a>
123+
<a href="https://github.com/Turtle-Hwan" title="Turtle-Hwan"><img src="https://avatars.githubusercontent.com/u/67897841?v=4" alt="Turtle-Hwan" width="64" height="64" style="border-radius: 50%;" /></a>
124+
125+
<!-- CONTRIBUTORS:END -->
126+
127+
## Star History
128+
129+
<a href="https://www.star-history.com/?repos=kisusu115%2Fmentory-time&type=date&legend=top-left">
130+
<picture>
131+
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/chart?repos=kisusu115/mentory-time&type=date&theme=dark&legend=top-left" />
132+
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/chart?repos=kisusu115/mentory-time&type=date&legend=top-left" />
133+
<img alt="Star History Chart" src="https://api.star-history.com/chart?repos=kisusu115/mentory-time&type=date&legend=top-left" />
134+
</picture>
135+
</a>

0 commit comments

Comments
 (0)