@even-toolkit/create-even-app 1.1.0 → 1.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 +82 -0
  2. package/package.json +3 -2
package/README.md ADDED
@@ -0,0 +1,82 @@
1
+ # @even-toolkit/create-even-app
2
+
3
+ Scaffold a new [Even Realities G2](https://www.evenrealities.com) smart glasses app from a template gallery.
4
+
5
+ ## Usage
6
+
7
+ ```bash
8
+ npx @even-toolkit/create-even-app my-app
9
+ ```
10
+
11
+ Or via the toolkit shortcut:
12
+
13
+ ```bash
14
+ npx even-toolkit my-app
15
+ ```
16
+
17
+ ## Templates
18
+
19
+ | Template | Description |
20
+ |----------|------------|
21
+ | **minimal** | Clean starter with AppShell and NavHeader |
22
+ | **dashboard** | Analytics dashboard with charts, stats, and timeline |
23
+ | **notes** | Notes app with search, categories, and CRUD |
24
+ | **chat** | AI chat interface with voice input |
25
+ | **tracker** | Activity tracker with calendar, timer, and progress |
26
+ | **media** | Media gallery with audio player and file uploads |
27
+
28
+ Every template includes:
29
+
30
+ - React 19 + React Router 7 + Tailwind CSS v4
31
+ - [even-toolkit](https://www.npmjs.com/package/even-toolkit) components and design tokens
32
+ - G2 glasses SDK integration (splash screen, display rendering, gestures)
33
+ - `app.json` manifest ready for `.ehpk` packaging
34
+ - TypeScript, Vite, and hot reload
35
+
36
+ ## After scaffolding
37
+
38
+ ```bash
39
+ cd my-app
40
+ npm install
41
+ npm run dev
42
+ ```
43
+
44
+ Test with the G2 simulator:
45
+
46
+ ```bash
47
+ npx @evenrealities/evenhub-simulator@latest http://localhost:5173
48
+ ```
49
+
50
+ Build and package for the Even Hub:
51
+
52
+ ```bash
53
+ npm run build
54
+ npx @evenrealities/evenhub-cli pack app.json dist
55
+ ```
56
+
57
+ ## Contributing templates
58
+
59
+ 1. Create a new directory under `templates/`
60
+ 2. Add a `template.json` manifest:
61
+ ```json
62
+ {
63
+ "name": "my-template",
64
+ "displayName": "My Template",
65
+ "description": "Short description of the template",
66
+ "tags": ["tag1", "tag2"],
67
+ "components": ["Button", "Card"]
68
+ }
69
+ ```
70
+ 3. Add your app files — use `{{APP_NAME}}`, `{{DISPLAY_NAME}}`, `{{DISPLAY_NAME_UPPER}}`, `{{PACKAGE_ID}}` as placeholders
71
+ 4. The CLI auto-discovers templates from the `templates/` directory
72
+
73
+ ## Links
74
+
75
+ - [even-toolkit](https://www.npmjs.com/package/even-toolkit) — component library
76
+ - [Live component demo](https://even-demo.vercel.app)
77
+ - [Even Hub SDK](https://www.npmjs.com/package/@evenrealities/even_hub_sdk)
78
+ - [Even Hub CLI](https://www.npmjs.com/package/@evenrealities/evenhub-cli)
79
+
80
+ ## License
81
+
82
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@even-toolkit/create-even-app",
3
- "version": "1.1.0",
3
+ "version": "1.1.1",
4
4
  "description": "Scaffold a new Even Realities G2 glasses app from a template gallery",
5
5
  "type": "module",
6
6
  "bin": {
@@ -8,7 +8,8 @@
8
8
  },
9
9
  "files": [
10
10
  "index.js",
11
- "templates/"
11
+ "templates/",
12
+ "README.md"
12
13
  ],
13
14
  "keywords": [
14
15
  "even-realities",