Add core-v2 skill and make installable
This commit is contained in:
49
README.md
49
README.md
@@ -4,6 +4,55 @@ Native Vue Router is a gesture-first navigation runtime for Vue 3 and Vue Router
|
||||
|
||||
The repository includes a reusable headless core, a platform-adaptive visual preset, Capacitor and Electron adapters, and one messaging demo delivered as a PWA and through native hosts.
|
||||
|
||||
## Install the routeless core-v2 experiment
|
||||
|
||||
The repository root is an installable facade for
|
||||
`@native-vue-router/core-v2`. npm builds the package from source when it installs
|
||||
the Git dependency:
|
||||
|
||||
```bash
|
||||
npm install git+https://git.harvmaster.com/Harvmaster/Native-Router-Vue.git
|
||||
```
|
||||
|
||||
Import it by its package name and include the compositor stylesheet:
|
||||
|
||||
```ts
|
||||
import {
|
||||
OriginScene,
|
||||
createOriginScene,
|
||||
gesture,
|
||||
originView,
|
||||
} from "@native-vue-router/core-v2";
|
||||
import "@native-vue-router/core-v2/style.css";
|
||||
```
|
||||
|
||||
Pin production applications to a commit or tag:
|
||||
|
||||
```bash
|
||||
npm install "git+https://git.harvmaster.com/Harvmaster/Native-Router-Vue.git#<commit-or-tag>"
|
||||
```
|
||||
|
||||
Core-v2 is routeless and does not depend on Vue Router. Its usage guide and API
|
||||
are in [packages/core-v2/README.md](packages/core-v2/README.md) and
|
||||
[packages/core-v2/API.md](packages/core-v2/API.md).
|
||||
|
||||
### Codex skill
|
||||
|
||||
The Git package also includes
|
||||
[`build-with-native-vue-router-v2`](skills/build-with-native-vue-router-v2/SKILL.md),
|
||||
a Codex skill for creating and integrating routeless core-v2 applications.
|
||||
After installing the dependency, copy the skill into Codex's skill directory:
|
||||
|
||||
```bash
|
||||
mkdir -p "${CODEX_HOME:-$HOME/.codex}/skills"
|
||||
cp -R \
|
||||
node_modules/@native-vue-router/core-v2/skills/build-with-native-vue-router-v2 \
|
||||
"${CODEX_HOME:-$HOME/.codex}/skills/"
|
||||
```
|
||||
|
||||
Restart or reload Codex if necessary, then invoke it explicitly with
|
||||
`$build-with-native-vue-router-v2`.
|
||||
|
||||
## What works
|
||||
|
||||
- Interactive edge pop that can be held indefinitely at any progress.
|
||||
|
||||
Reference in New Issue
Block a user