@notionhive/testimonials 0.1.0 → 0.1.1

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.
Files changed (2) hide show
  1. package/README.md +113 -0
  2. package/package.json +4 -3
package/README.md ADDED
@@ -0,0 +1,113 @@
1
+ # @notionhive/testimonials
2
+
3
+ Copy **editable testimonial sections** into your Next.js project — source you own and can change locally, not a black-box `node_modules` import.
4
+
5
+ Works like `shadcn add`: run once per component to eject files into your app.
6
+
7
+ ## Requirements
8
+
9
+ Your project needs:
10
+
11
+ - **Node.js** 18+
12
+ - **Next.js** 16+
13
+ - **Tailwind CSS** v4
14
+ - **prop-types**
15
+
16
+ Path alias `@/` should resolve to your project root (default in Next.js).
17
+
18
+ ## Quick start
19
+
20
+ ```bash
21
+ npx @notionhive/testimonials add testimonial-01
22
+ ```
23
+
24
+ Target a specific app directory:
25
+
26
+ ```bash
27
+ npx @notionhive/testimonials add testimonial-01 --dir ./my-app
28
+ ```
29
+
30
+ List all available testimonial sections:
31
+
32
+ ```bash
33
+ npx @notionhive/testimonials list
34
+ ```
35
+
36
+ ## Use in your app
37
+
38
+ ```jsx
39
+ import { Testimonial01 } from "@/components/Testimonial01";
40
+
41
+ export default function Page() {
42
+ return <Testimonial01 />;
43
+ }
44
+ ```
45
+
46
+ Props are defined in `Testimonial01.propTypes.js` inside the copied folder. Override any prop in JSX or spread defaults from that file.
47
+
48
+ ## What gets copied
49
+
50
+ | Path | Description |
51
+ |------|-------------|
52
+ | `components/<Name>/` | Component source + `propTypes` |
53
+ | `components/_shared/` | SafeImage, hooks, molecules (only what the component needs) |
54
+ | `public/testimonials/...` | Static assets when the design uses them |
55
+
56
+ Re-run with `--force` to overwrite existing files:
57
+
58
+ ```bash
59
+ npx @notionhive/testimonials add testimonial-01 --force
60
+ ```
61
+
62
+ ## Available testimonial sections
63
+
64
+ - `testimonial-01` → `Testimonial01`
65
+ - `testimonial-02` → `Testimonial02`
66
+ - `testimonial-03` → `Testimonial03`
67
+ - `testimonial-04` → `Testimonial04`
68
+ - `testimonial-05` → `Testimonial05`
69
+ - `testimonial-06` → `Testimonial06`
70
+ - `testimonial-07` → `Testimonial07`
71
+ - `testimonial-08` → `Testimonial08`
72
+ - `testimonial-09` → `Testimonial09`
73
+ - `testimonial-10` → `Testimonial10`
74
+ - `testimonial-11` → `Testimonial11`
75
+ - `testimonial-12` → `Testimonial12`
76
+ - `testimonial-13` → `Testimonial13`
77
+ - `testimonial-14` → `Testimonial14`
78
+ - `testimonial-15` → `Testimonial15`
79
+ - `testimonial-16` → `Testimonial16`
80
+ - `testimonial-17` → `Testimonial17`
81
+
82
+ ## CLI reference
83
+
84
+ ```bash
85
+ npx @notionhive/testimonials add <testimonial section-id> [--dir <path>] [--force]
86
+ npx @notionhive/testimonials list
87
+ npx @notionhive/testimonials --help
88
+ ```
89
+
90
+ | Flag | Description |
91
+ |------|-------------|
92
+ | `--dir` | Target project root (default: current directory) |
93
+ | `--force` | Overwrite files that already exist |
94
+
95
+ ## Other categories
96
+
97
+ | Package | Example |
98
+ |---------|---------|
99
+ | `@notionhive/heroes` | `npx @notionhive/heroes add hero-05` |
100
+ | `@notionhive/menus` | `npx @notionhive/menus add menu-01` |
101
+ | `@notionhive/about` | `npx @notionhive/about add about-01` |
102
+ | `@notionhive/services` | `npx @notionhive/services add service-01` |
103
+ | `@notionhive/contacts` | `npx @notionhive/contacts add contact-01` |
104
+ | `@notionhive/footers` | `npx @notionhive/footers add footer-07` |
105
+ | `@notionhive/ctas` | `npx @notionhive/ctas add cta-03` |
106
+
107
+ ## Browse components
108
+
109
+ See the Notionhive component library Storybook for previews, props, and eject commands for every variant.
110
+
111
+ ## License
112
+
113
+ UNLICENSED — internal Notionhive use unless otherwise specified.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@notionhive/testimonials",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Add editable testimonial sections into your Next.js project.",
5
5
  "license": "UNLICENSED",
6
6
  "bin": {
@@ -10,13 +10,14 @@
10
10
  "bin",
11
11
  "registry",
12
12
  "templates",
13
- "category.config.json"
13
+ "category.config.json",
14
+ "README.md"
14
15
  ],
15
16
  "scripts": {
16
17
  "prepublishOnly": "node ../../scripts/sync-templates.js"
17
18
  },
18
19
  "dependencies": {
19
- "@notionhive/core": "0.1.0"
20
+ "@notionhive/core": "0.1.1"
20
21
  },
21
22
  "engines": {
22
23
  "node": ">=18"