milstead 0.1.0 → 0.1.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 +2 -34
- package/bin/milst.js +0 -0
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -1,39 +1,7 @@
|
|
|
1
1
|
# milst
|
|
2
2
|
|
|
3
|
-
Michael Milstead's
|
|
3
|
+
Michael Milstead's terminal page.
|
|
4
4
|
|
|
5
5
|
```bash
|
|
6
|
-
npx
|
|
6
|
+
npx milstead
|
|
7
7
|
```
|
|
8
|
-
|
|
9
|
-
A full-screen terminal UI: a pixel wordmark, your name, an ANSI-art portrait,
|
|
10
|
-
and links you can open in your browser.
|
|
11
|
-
|
|
12
|
-
## Keys
|
|
13
|
-
|
|
14
|
-
| Key | Action |
|
|
15
|
-
| -------------- | ------------------------------- |
|
|
16
|
-
| `s` | open personal site |
|
|
17
|
-
| `g` | open GitHub profile |
|
|
18
|
-
| `x` | open X profile |
|
|
19
|
-
| `q` / `Esc` | quit |
|
|
20
|
-
|
|
21
|
-
## Make it yours
|
|
22
|
-
|
|
23
|
-
- **Content** — edit [`src/data/profile.ts`](src/data/profile.ts): wordmark,
|
|
24
|
-
name, and links. That's the only file you need to touch.
|
|
25
|
-
- **Portrait** — drop a photo at `assets/portrait.png` and run
|
|
26
|
-
`npm run portrait`. See [`assets/README.md`](assets/README.md).
|
|
27
|
-
|
|
28
|
-
## Develop
|
|
29
|
-
|
|
30
|
-
```bash
|
|
31
|
-
npm install
|
|
32
|
-
npm run portrait # generate the portrait (placeholder if no photo)
|
|
33
|
-
npm run build # compile src/ -> dist/
|
|
34
|
-
npm start # run the built CLI locally
|
|
35
|
-
npm test # vitest
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
Built with [Ink](https://github.com/vadimdemedes/ink) (React for the terminal),
|
|
39
|
-
compiled with [tsup](https://tsup.egoist.dev/).
|
package/bin/milst.js
CHANGED
|
File without changes
|
package/package.json
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "milstead",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "Michael Milstead's
|
|
3
|
+
"version": "0.1.2",
|
|
4
|
+
"description": "Michael Milstead's terminal page. Run: npx milstead",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
7
|
+
"milstead": "bin/milst.js",
|
|
7
8
|
"milst": "bin/milst.js"
|
|
8
9
|
},
|
|
9
10
|
"files": [
|