@stag-build/phonebook 0.1.1 → 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 +44 -4
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<div align="center">
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<img src="https://raw.githubusercontent.com/stag-build/phonebook/main/assets/phonebook-logo-lockup.svg" alt="Phonebook" width="360" />
|
|
4
4
|
|
|
5
5
|
<p>A self-hosted, open-source alternative to Emerge Tools Snapshots: harvest your existing Compose <code>@Preview</code>s and SwiftUI <code>#Preview</code>s into a browsable, static HTML gallery — no SaaS account required.</p>
|
|
6
6
|
|
|
@@ -21,9 +21,13 @@ Phonebook turns screenshots your team already has into a Storybook-style compone
|
|
|
21
21
|
|
|
22
22
|
## Demo
|
|
23
23
|
|
|
24
|
-
](https://youtu.be/trHbUaG784w)
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
A gallery generated from `samples/ios` — `component / state` cards grouped from the app's own `#Preview`s, no extra annotation.
|
|
29
|
+
|
|
30
|
+
**[Browse the live gallery →](https://stag-build.github.io/phonebook/)**
|
|
27
31
|
|
|
28
32
|
## How it works
|
|
29
33
|
|
|
@@ -32,7 +36,43 @@ Phonebook turns screenshots your team already has into a Storybook-style compone
|
|
|
32
36
|
- iOS: [SnapshotPreviews](https://github.com/getsentry/SnapshotPreviews), run via `xcodebuild test` on a simulator. Requires macOS.
|
|
33
37
|
2. `phonebook build` turns that bundle into a static site — by default it writes `index.html` directly into the bundle directory (reusing the images already there, no copying), so the site lands at `<bundle>/index.html`. Pass `-o <dir>` to instead copy everything into a standalone site directory (for publishing elsewhere, or later merging multiple bundles). Plain HTML/CSS/JS, works from `file://` or any static host.
|
|
34
38
|
|
|
35
|
-
|
|
39
|
+
## Installation
|
|
40
|
+
|
|
41
|
+
<details>
|
|
42
|
+
<summary><strong>npm</strong></summary>
|
|
43
|
+
|
|
44
|
+
```sh
|
|
45
|
+
npm install -g @stag-build/phonebook
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
</details>
|
|
49
|
+
|
|
50
|
+
<details>
|
|
51
|
+
<summary><strong>Homebrew</strong></summary>
|
|
52
|
+
|
|
53
|
+
```sh
|
|
54
|
+
brew install stag-build/phonebook/phonebook
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Or tap first, then install:
|
|
58
|
+
|
|
59
|
+
```sh
|
|
60
|
+
brew tap stag-build/phonebook
|
|
61
|
+
brew install phonebook
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Formula source: [stag-build/homebrew-phonebook](https://github.com/stag-build/homebrew-phonebook).
|
|
65
|
+
|
|
66
|
+
</details>
|
|
67
|
+
|
|
68
|
+
<details>
|
|
69
|
+
<summary><strong>No install (npx)</strong></summary>
|
|
70
|
+
|
|
71
|
+
```sh
|
|
72
|
+
npx @stag-build/phonebook <cmd>
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
</details>
|
|
36
76
|
|
|
37
77
|
## Using it with a coding agent (recommended)
|
|
38
78
|
|
package/package.json
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stag-build/phonebook",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "Storybook-style static gallery generated from Compose @Preview / SwiftUI #Preview screenshots",
|
|
5
5
|
"license": "MIT",
|
|
6
|
+
"mcpName": "io.github.stag-build/phonebook",
|
|
6
7
|
"type": "module",
|
|
7
8
|
"repository": {
|
|
8
9
|
"type": "git",
|