@vantail/shared 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 +23 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# @vantail/shared
|
|
2
|
+
|
|
3
|
+
Configuration types, schema and loader shared between the
|
|
4
|
+
[Vantail](https://github.com/Vantail/vantail) command line and the runtime.
|
|
5
|
+
|
|
6
|
+
This is tooling, not something an application imports. If you are building an
|
|
7
|
+
application, you want [`@vantail/api`](https://www.npmjs.com/package/@vantail/api)
|
|
8
|
+
for the native APIs and
|
|
9
|
+
[`@vantail/cli`](https://www.npmjs.com/package/@vantail/cli) for
|
|
10
|
+
`defineConfig`.
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
npm create @vantail my-app
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## What is in it
|
|
17
|
+
|
|
18
|
+
The single definition of what `vantail.config.ts` may contain: the window, the
|
|
19
|
+
menu, the tray, the updater, and the permission model. The CLI validates
|
|
20
|
+
against it and compiles it to the `vantail.json` the native runtime reads at
|
|
21
|
+
startup, so both sides agree on the shape without either owning it.
|
|
22
|
+
|
|
23
|
+
MIT licensed.
|