Skip to content

Commit 797761e

Browse files
committed
Updated README to include GitLab support and new features
1 parent c5a3508 commit 797761e

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,28 @@
11
# Git Music
22

3-
Turn your GitHub contributions into music. 🎵
3+
Turn your GitHub & GitLab contributions into music. 🎵
44

5-
Git Music takes a GitHub username, fetches the contribution history for the last year, and turns regular activity patterns into a musical sequence.
5+
Git Music takes a username, automatically scans both **GitHub** and **GitLab** to find the most active profile, and turns your coding activity patterns into a unique, ambient musical sequence.
66

77
![Git Music Demo](./public/demo.png)
88

99
## Features
1010

11-
- **Visualize & Listen**: See your contribution graph light up as it plays notes based on your commit history.
12-
- **Audio Sequencing**: Uses [Tone.js](https://tonejs.github.io/) to synthesize sounds corresponding to contribution levels (0-4).
13-
- **Share**: Generate a shareable link to show off your melodic commit history.
14-
- **Export**: Record and download a `.webm` video of your graph playing.
15-
- **Interactive**: Keyboard shortcuts for playback and control.
11+
- **Multi-Platform Support**: Works with both GitHub and GitLab. Automatically detects which platform has more activity.
12+
- **Ambient Audio Engine**: Uses [Tone.js](https://tonejs.github.io/) to generate soothing, reverb-drenched soundscapes based on your work habits.
13+
- **Visualize & Listen**: Watch your contribution graph light up in sync with the melody.
14+
- **Share**: Generate a clean, shareable link (e.g., `gitmusic.com/username`) that auto-resolves the correct platform for visitors.
15+
- **Export**: Record and download a high-quality `.webm` or `.mp4` video of your graph playing.
16+
- **Interactive**: Keyboard shortcuts for playback, recording, and sharing.
1617

1718
## Usage
1819

19-
1. Enter a GitHub username.
20-
2. Press **Enter** or click fetch.
21-
3. Press **Space** or click Play to listen.
20+
1. Enter a GitHub or GitLab username.
21+
2. Press **Enter** - the app will auto-detect your platform.
22+
3. Press **Space** or click Play to listen to your year in code.
23+
24+
> **Tip**: Can't find the right profile? You can force a specific platform by typing:
25+
> `$ gitmusic fetch username -p gitlab`
2226
2327
### Keyboard Shortcuts
2428

@@ -32,9 +36,10 @@ Git Music takes a GitHub username, fetches the contribution history for the last
3236
## Tech Stack
3337

3438
- **React** (Vite)
35-
- **Tone.js** for audio synthesis
39+
- **Tone.js** for audio synthesis (PolySynths, FMSine, Reverb)
3640
- **Axios** for data fetching
3741
- **GitHub Contribution API** (via [github-contributions-api](https://github.com/grubersjoe/github-contributions-api))
42+
- **GitLab API** (via custom proxy)
3843

3944
## Development
4045

0 commit comments

Comments
 (0)