screenbook 1.1.1 → 1.1.3
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 +10 -33
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
<p align="center">
|
|
2
2
|
<picture>
|
|
3
|
-
<source media="(prefers-color-scheme: dark)" srcset="assets/logo/logo.svg">
|
|
4
|
-
<source media="(prefers-color-scheme: light)" srcset="assets/logo/logo-dark.svg">
|
|
5
|
-
<img alt="Screenbook" src="assets/logo/logo-dark.svg" height="48">
|
|
3
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/wadakatu/screenbook/main/assets/logo/logo.svg">
|
|
4
|
+
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/wadakatu/screenbook/main/assets/logo/logo-dark.svg">
|
|
5
|
+
<img alt="Screenbook" src="https://raw.githubusercontent.com/wadakatu/screenbook/main/assets/logo/logo-dark.svg" height="48">
|
|
6
6
|
</picture>
|
|
7
7
|
</p>
|
|
8
8
|
|
|
@@ -11,57 +11,32 @@
|
|
|
11
11
|
</p>
|
|
12
12
|
|
|
13
13
|
<p align="center">
|
|
14
|
-
<img src="assets/screenshots/hero.png" alt="Screenbook Hero" width="800">
|
|
14
|
+
<img src="https://raw.githubusercontent.com/wadakatu/screenbook/main/assets/screenshots/hero.png" alt="Screenbook Hero" width="800">
|
|
15
15
|
</p>
|
|
16
16
|
|
|
17
17
|
<p align="center">
|
|
18
18
|
<a href="https://github.com/wadakatu/screenbook/actions/workflows/ci.yml"><img src="https://github.com/wadakatu/screenbook/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
|
|
19
|
+
<a href="https://codecov.io/gh/wadakatu/screenbook"><img src="https://codecov.io/gh/wadakatu/screenbook/graph/badge.svg" alt="Coverage"></a>
|
|
19
20
|
<a href="https://github.com/wadakatu/screenbook/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></a>
|
|
20
21
|
<a href="https://github.com/wadakatu/screenbook"><img src="https://img.shields.io/badge/TypeScript-5.0+-blue.svg" alt="TypeScript"></a>
|
|
21
22
|
<a href="https://github.com/wadakatu/screenbook"><img src="https://img.shields.io/badge/Node.js-22+-green.svg" alt="Node.js"></a>
|
|
22
23
|
</p>
|
|
23
24
|
|
|
24
25
|
<p align="center">
|
|
26
|
+
<a href="https://wadakatu.github.io/screenbook">Documentation</a> •
|
|
25
27
|
<a href="#quick-start">Quick Start</a> •
|
|
26
|
-
<a href="#features">Features</a> •
|
|
27
28
|
<a href="#why-screenbook">Why Screenbook?</a> •
|
|
28
29
|
<a href="#cli-commands">CLI</a>
|
|
29
30
|
</p>
|
|
30
31
|
|
|
31
32
|
---
|
|
32
33
|
|
|
33
|
-
## Features
|
|
34
|
-
|
|
35
|
-
### Screen Catalog
|
|
36
|
-
|
|
37
|
-
<img src="assets/screenshots/screens.png" alt="Screen Catalog" width="700">
|
|
38
|
-
|
|
39
|
-
Browse all screens in your application. **Search by name, filter by tags, find by owner.** Every screen shows its route, dependencies, and navigation connections.
|
|
40
|
-
|
|
41
|
-
### Navigation Graph
|
|
42
|
-
|
|
43
|
-
<img src="assets/screenshots/graph.png" alt="Navigation Graph" width="700">
|
|
44
|
-
|
|
45
|
-
**Visualize how users flow through your app.** See the big picture at a glance. Understand navigation paths without reading code.
|
|
46
|
-
|
|
47
|
-
### Impact Analysis
|
|
48
|
-
|
|
49
|
-
<img src="assets/screenshots/impact.png" alt="Impact Analysis" width="700">
|
|
50
|
-
|
|
51
|
-
**Changing an API? Know exactly which screens break — before you ship.** Enter an API name and instantly see all affected screens, both direct and transitive dependencies.
|
|
52
|
-
|
|
53
|
-
### Coverage Dashboard
|
|
54
|
-
|
|
55
|
-
<img src="assets/screenshots/coverage.png" alt="Coverage Report" width="700">
|
|
56
|
-
|
|
57
|
-
**Track documentation completeness across your app.** See coverage by owner and tag. Find gaps. Enforce coverage in CI to prevent drift.
|
|
58
|
-
|
|
59
|
-
---
|
|
60
|
-
|
|
61
34
|
## Quick Start
|
|
62
35
|
|
|
63
36
|
```bash
|
|
64
37
|
# Install
|
|
38
|
+
npm i -D screenbook
|
|
39
|
+
# or
|
|
65
40
|
pnpm add -D screenbook
|
|
66
41
|
|
|
67
42
|
# Initialize configuration
|
|
@@ -73,6 +48,8 @@ npx screenbook dev
|
|
|
73
48
|
|
|
74
49
|
Open http://localhost:4321 and explore your screen catalog.
|
|
75
50
|
|
|
51
|
+
**For full documentation, visit [wadakatu.github.io/screenbook](https://wadakatu.github.io/screenbook).**
|
|
52
|
+
|
|
76
53
|
---
|
|
77
54
|
|
|
78
55
|
## Defining Screens
|