maplibre-yaml 0.1.0 → 0.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 +13 -4
  2. package/package.json +7 -4
package/README.md CHANGED
@@ -1,15 +1,24 @@
1
1
  # maplibre-yaml
2
2
 
3
- An alias for [`@maplibre-yaml/cli`](https://www.npmjs.com/package/@maplibre-yaml/cli), the maplibre-yaml command line.
3
+ Runs [`@maplibre-yaml/cli`](https://www.npmjs.com/package/@maplibre-yaml/cli),
4
+ the maplibre-yaml command line, under a short name, so one-off commands need
5
+ no install:
4
6
 
5
7
  ```bash
6
- npx maplibre-yaml validate my-map.yaml
8
+ npx maplibre-yaml init my-map
9
+ npx maplibre-yaml validate my-map/map.yaml
7
10
  ```
8
11
 
9
- It installs `@maplibre-yaml/cli` and runs it, so every command and flag is the same. For projects, install the CLI itself:
12
+ Every command and flag is the CLI's own: `init`, `validate`, `preview`,
13
+ `emit`, `schema` and `bake`. See the
14
+ [command reference](https://docs.maplibre-yaml.org/cli/reference/).
15
+
16
+ For a project, install the CLI itself. That also gives you the short
17
+ `mlym` command (`npx mlym …`, or `mlym …` after a global install):
10
18
 
11
19
  ```bash
12
20
  npm install --save-dev @maplibre-yaml/cli
13
21
  ```
14
22
 
15
- Docs: https://docs.maplibre-yaml.org
23
+ To put maps on a page, see [`@maplibre-yaml/core`](https://www.npmjs.com/package/@maplibre-yaml/core)
24
+ and the docs at [docs.maplibre-yaml.org](https://docs.maplibre-yaml.org).
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "maplibre-yaml",
3
- "version": "0.1.0",
4
- "description": "Alias for @maplibre-yaml/cli, so `npx maplibre-yaml` runs the maplibre-yaml command line (validate, preview, init, schema, emit).",
3
+ "version": "0.1.1",
4
+ "description": "Runs @maplibre-yaml/cli as `npx maplibre-yaml` (init, validate, preview, emit, schema, bake) with no install.",
5
5
  "type": "module",
6
6
  "bin": {
7
7
  "maplibre-yaml": "bin.js"
@@ -12,7 +12,7 @@
12
12
  "LICENSE.md"
13
13
  ],
14
14
  "dependencies": {
15
- "@maplibre-yaml/cli": "^0.4.1"
15
+ "@maplibre-yaml/cli": "^0.4.2"
16
16
  },
17
17
  "engines": {
18
18
  "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
@@ -24,13 +24,16 @@
24
24
  "maps",
25
25
  "cli"
26
26
  ],
27
- "homepage": "https://docs.maplibre-yaml.org",
27
+ "homepage": "https://docs.maplibre-yaml.org/cli/reference/",
28
28
  "license": "MIT",
29
29
  "repository": {
30
30
  "type": "git",
31
31
  "url": "git+https://github.com/design-practices/maplibre-yaml.git",
32
32
  "directory": "packages/maplibre-yaml"
33
33
  },
34
+ "bugs": {
35
+ "url": "https://github.com/design-practices/maplibre-yaml/issues"
36
+ },
34
37
  "publishConfig": {
35
38
  "access": "public",
36
39
  "registry": "https://registry.npmjs.org"