@carto/ps-utils 0.1.0-alpha.6 → 1.0.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.
Files changed (2) hide show
  1. package/README.md +11 -1
  2. package/package.json +5 -2
package/README.md CHANGED
@@ -2,7 +2,17 @@
2
2
 
3
3
  This repository contains the packages with utils helpers.
4
4
 
5
- The see what helpers are available, the functions and examples, see [docs](https://github.com/CartoDB/carto-ps-lib/blob/main/packages/utils/docs/README.md) section.
5
+ ## Installation
6
+
7
+ Install @carto/ps-utils like dependence:
8
+
9
+ ```bash
10
+ npm install --save @carto/ps-utils
11
+ ```
12
+
13
+ ## Usage
14
+
15
+ The see what helpers are available, the functions and examples, see [docs](https://github.com/CartoDB/carto-ps-lib/blob/main/docs/modules/carto_ps_utils.md) section.
6
16
 
7
17
  ## Contributing
8
18
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@carto/ps-utils",
3
- "version": "0.1.0-alpha.6",
3
+ "version": "1.0.0",
4
4
  "description": "CARTO's Professional Service Utils library",
5
5
  "files": [
6
6
  "dist"
@@ -19,10 +19,13 @@
19
19
  "build": "vite build",
20
20
  "lint": "eslint './**/*.{ts,tsx}' --ignore-path ../../.gitignore",
21
21
  "format": "prettier --write . --ignore-path ../../.gitignore",
22
- "docs:generate": "typedoc --options ../../typedoc.json src/index.ts",
23
22
  "test:watch": "vitest",
24
23
  "test:related": "vitest --run --passWithNoTests",
25
24
  "test:coverage": "vitest run --coverage"
26
25
  },
26
+ "typedoc": {
27
+ "entryPoint": "./src/index.ts",
28
+ "readmeFile": "./README.md"
29
+ },
27
30
  "dependencies": {}
28
31
  }