@glandais/vcyclist-elevation-wasm 1.1.0 → 1.2.0
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 +25 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -148,6 +148,19 @@ On Node.js / Bun, tile decoding uses [`@jsquash/webp`](https://www.npmjs.com/pac
|
|
|
148
148
|
Node ≥ 18 (`globalThis.fetch` is built-in since Node 18 / Bun) ; Node 22+ recommended for
|
|
149
149
|
ESM `require()` support.
|
|
150
150
|
|
|
151
|
+
## Try the interactive demo
|
|
152
|
+
|
|
153
|
+
The [`demo/`](demo/) module is a Vue 3 + Vite frontend that exercises the
|
|
154
|
+
Kotlin/JS engine end-to-end in a browser (GPX upload, configurable cyclist /
|
|
155
|
+
bike / wind / power, chart + map, hover sync).
|
|
156
|
+
|
|
157
|
+
```bash
|
|
158
|
+
./gradlew :demo:assemble
|
|
159
|
+
python -m http.server -d demo/dist 8000 # or any static file server
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
See [`demo/README.md`](demo/README.md) for the dev workflow and architecture.
|
|
163
|
+
|
|
151
164
|
## Build & test
|
|
152
165
|
|
|
153
166
|
```bash
|
|
@@ -205,8 +218,20 @@ output points covering ~128.6 km / ~5.3 h of simulated ride.
|
|
|
205
218
|
- [`docs/parity.md`](docs/parity.md) — TS↔Kotlin parity approach and tolerances.
|
|
206
219
|
- [`docs/kotlin-wasm-jvm-webp.md`](docs/kotlin-wasm-jvm-webp.md) — Kotlin/Wasm ↔ JS interop
|
|
207
220
|
guide that underpins the `@JsExport` façades and the WebP tile decoding.
|
|
221
|
+
- [`docs/publishing.md`](docs/publishing.md) — release flow (Maven Central + npm via
|
|
222
|
+
semantic-release on push to `develop`).
|
|
208
223
|
- [`elevation/README.md`](elevation/README.md) — `:elevation` module details + browser demos.
|
|
209
224
|
|
|
225
|
+
## Contributing
|
|
226
|
+
|
|
227
|
+
`develop` is the **default and only long-lived branch** — there is no `main`. Open PRs
|
|
228
|
+
against `develop` using [Conventional Commits](https://www.conventionalcommits.org/) :
|
|
229
|
+
`feat:` triggers a minor release, `fix:` a patch, anything else is a no-op release-wise.
|
|
230
|
+
Every push to `develop` runs the full multi-target test suite via
|
|
231
|
+
`.github/workflows/release.yml` and, if green, lets semantic-release tag a new version,
|
|
232
|
+
publish to Maven Central + npm, and commit the version bump back to `develop` with
|
|
233
|
+
`[skip ci]`. See [`docs/publishing.md`](docs/publishing.md) for the full flow.
|
|
234
|
+
|
|
210
235
|
## License
|
|
211
236
|
|
|
212
237
|
Apache License 2.0, aligned with the upstream `gpx2web` project. See the Maven Central POM
|