headreel 1.7.0 → 1.7.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -12,7 +12,7 @@ Animated banners for your GitHub profile, made from your GitHub activity.
|
|
|
12
12
|
Pick one way to make your banner:
|
|
13
13
|
|
|
14
14
|
- [GitHub Action](#github-action): updates the banner every day. No setup on your computer.
|
|
15
|
-
- [
|
|
15
|
+
- [CLI command](#cli-command): makes the banner once on your computer.
|
|
16
16
|
|
|
17
17
|
## GitHub Action
|
|
18
18
|
|
|
@@ -59,19 +59,17 @@ The setup above uses `publish_mode: branch`. The banner lives on its own `headre
|
|
|
59
59
|
|
|
60
60
|
If you remove `publish_mode: branch`, each update adds a new commit to your main branch. Old banners stay in your history, and each one is a few MB.
|
|
61
61
|
|
|
62
|
-
##
|
|
62
|
+
## CLI command
|
|
63
63
|
|
|
64
64
|
Run this command. Replace `octocat` with your GitHub username.
|
|
65
65
|
|
|
66
66
|
```bash
|
|
67
|
-
npx headreel --style
|
|
67
|
+
npx headreel --style highlights-reel --user octocat --tagline "Open source maintainer" --website https://example.com --option theme=dark --option accent=green
|
|
68
68
|
```
|
|
69
69
|
|
|
70
70
|
The command saves `headreel.gif` in the current folder. Add the file to your repository, and add `` to its `README.md`.
|
|
71
71
|
|
|
72
|
-
You need
|
|
73
|
-
|
|
74
|
-
- A GitHub token. headreel uses `--token`, then `GITHUB_TOKEN`, then your [GitHub CLI](https://cli.github.com) login (`gh auth login`).
|
|
72
|
+
You need a GitHub token. Pass `--token`, set `GITHUB_TOKEN`, or log in with the [GitHub CLI](https://cli.github.com) (`gh auth login`).
|
|
75
73
|
|
|
76
74
|
## Settings
|
|
77
75
|
|
|
@@ -122,13 +120,13 @@ Set the style with `style: <name>` in the Action, or `--style <name>` in the com
|
|
|
122
120
|
|
|
123
121
|
### Spec Sheet
|
|
124
122
|
|
|
125
|
-
`spec-sheet`: your
|
|
123
|
+
`spec-sheet`: your profile as a printed spec card. Your avatar turns into a dot pattern that fades out and back in, next to your followers, stars, repositories and contributions.
|
|
126
124
|
|
|
127
125
|
|
|
128
126
|
|
|
129
|
-
| Option | Default | Description
|
|
130
|
-
| -------- | ------- |
|
|
131
|
-
| `accent` | `gray` |
|
|
127
|
+
| Option | Default | Description |
|
|
128
|
+
| -------- | ------- | --------------------------------------------------------------------------------- |
|
|
129
|
+
| `accent` | `gray` | Label, tagline, website and cursor: `gray`, `teal`, `cobalt`, `violet`, `sienna`. |
|
|
132
130
|
|
|
133
131
|
</td>
|
|
134
132
|
</tr>
|
|
@@ -159,7 +157,7 @@ Set the style with `style: <name>` in the Action, or `--style <name>` in the com
|
|
|
159
157
|
|
|
160
158
|
### Now Playing
|
|
161
159
|
|
|
162
|
-
`now-playing`: a cassette deck
|
|
160
|
+
`now-playing`: a cassette deck plays the repository you committed to most in the last 30 days. Your commit messages scroll across the display, and the meter shows each day of the month.
|
|
163
161
|
|
|
164
162
|
|
|
165
163
|
|
|
@@ -179,7 +177,7 @@ Set the style with `style: <name>` in the Action, or `--style <name>` in the com
|
|
|
179
177
|
|
|
180
178
|
### Receipt
|
|
181
179
|
|
|
182
|
-
`receipt`:
|
|
180
|
+
`receipt`: your last 12 months printed as a shop receipt. Your repositories are the items and your contributions are the totals, with your streaks and best day below.
|
|
183
181
|
|
|
184
182
|
|
|
185
183
|
|
|
@@ -199,7 +197,7 @@ Set the style with `style: <name>` in the Action, or `--style <name>` in the com
|
|
|
199
197
|
|
|
200
198
|
### Trail Profile
|
|
201
199
|
|
|
202
|
-
`trail-profile`: your last 12 months as a hiking trail
|
|
200
|
+
`trail-profile`: your last 12 months as a hiking trail. Each week's contributions set the trail's height. A hiker walks to your busiest week, the summit.
|
|
203
201
|
|
|
204
202
|
|
|
205
203
|
|
|
@@ -18,8 +18,8 @@ export const RIM = 0.12;
|
|
|
18
18
|
* length and mirror each other, and the hold between them wraps across the
|
|
19
19
|
* seam, so the loop reads as one even rhythm: hold, dissolve, rebuild.
|
|
20
20
|
*/
|
|
21
|
-
export const DISSOLVE = [
|
|
22
|
-
export const BUILD = [
|
|
21
|
+
export const DISSOLVE = [24 / 169, 84 / 169];
|
|
22
|
+
export const BUILD = [84 / 169, 144 / 169];
|
|
23
23
|
/** Share of a sub-phase a single dot takes to shrink or grow. */
|
|
24
24
|
const WINDOW = 0.2;
|
|
25
25
|
/** Share of a sub-phase given to the seeded jitter, which feathers the front. */
|
|
@@ -5,7 +5,7 @@ import { BUILD, DISSOLVE, halftoneDots, sphereLuma } from './halftone.js';
|
|
|
5
5
|
* the halftone screen. Everything here is a pure function of the data; the
|
|
6
6
|
* sketch only draws.
|
|
7
7
|
*/
|
|
8
|
-
export const FRAMES =
|
|
8
|
+
export const FRAMES = 169;
|
|
9
9
|
export const LAYOUT = {
|
|
10
10
|
width: 1280,
|
|
11
11
|
height: 400,
|