@ogis/waymark-js 2.0.0-alpha.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.
package/package.json ADDED
@@ -0,0 +1,46 @@
1
+ {
2
+ "name": "@ogis/waymark-js",
3
+ "version": "2.0.0-alpha.1",
4
+ "type": "module",
5
+ "license": "GPL-2.0-only",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "git+https://github.com/OpenGIS/Waymark-JS.git"
9
+ },
10
+ "bugs": {
11
+ "url": "https://github.com/OpenGIS/Waymark-JS/issues"
12
+ },
13
+ "homepage": "https://github.com/OpenGIS/Waymark-JS#readme",
14
+ "publishConfig": {
15
+ "access": "public"
16
+ },
17
+ "files": [
18
+ "dist/**/*.{js,cjs,css}"
19
+ ],
20
+ "main": "./dist/waymark-js.umd.cjs",
21
+ "module": "./dist/waymark-js.js",
22
+ "exports": {
23
+ ".": {
24
+ "import": "./dist/waymark-js.js",
25
+ "require": "./dist/waymark-js.umd.cjs"
26
+ }
27
+ },
28
+ "scripts": {
29
+ "build": "vite build",
30
+ "dev": "vite --host"
31
+ },
32
+ "dependencies": {
33
+ "@turf/length": "^7.2.0",
34
+ "font-awesome": "^4.7.0",
35
+ "ionicons-npm": "^2.0.1",
36
+ "maplibre-gl": "^5.7.1",
37
+ "pinia": "^2.1.7",
38
+ "vue": "^3.4.21"
39
+ },
40
+ "devDependencies": {
41
+ "@vitejs/plugin-vue": "^5.0.4",
42
+ "less": "^4.2.0",
43
+ "prettier": "^3.2.5",
44
+ "vite": "^6.3.5"
45
+ }
46
+ }
package/readme.md ADDED
@@ -0,0 +1,38 @@
1
+ # Waymark JS
2
+
3
+ ## Installation
4
+
5
+ ```bash
6
+ npm install @ogis/waymark-js
7
+ ```
8
+
9
+ ## Usage
10
+
11
+ ```javascript
12
+ import { createApp } from "vue";
13
+ import Waymark from "@ogis/waymark-js";
14
+ import "@ogis/waymark-js/dist/waymark-js.css";
15
+
16
+ const app = createApp({
17
+ // ...your root component
18
+ });
19
+
20
+ app.use(Waymark);
21
+ app.mount("#app");
22
+ ```
23
+
24
+ ## Development
25
+
26
+ > [!IMPORTANT]
27
+ > To build Waymark JS from source, you will need [Node and NPM installed](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
28
+
29
+ ```bash
30
+ # Install dependencies
31
+ npm install
32
+
33
+ # Run the development server
34
+ npm run dev
35
+
36
+ # Build for production
37
+ npm run build
38
+ ```