@socotra/ec-react-utils 0.0.0-alpha.3 → 2.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 +48 -0
  2. package/package.json +3 -3
package/README.md ADDED
@@ -0,0 +1,48 @@
1
+ # @socotra/ec-react-utils
2
+
3
+ A set of utility functions for integrating ec-react-components with API responses.
4
+
5
+ - **Package name**: `@socotra/ec-react-utils`
6
+ - **Repo Path**: `packages/utils`
7
+ - **Install**:
8
+ ```sh
9
+ npm i @socotra/ec-react-utils
10
+ ```
11
+ - **Usage**:
12
+
13
+ ```js
14
+ import { myUtilityFunction } from '@socotra/ec-react-utils';
15
+ ```
16
+
17
+ ### Running the Project
18
+
19
+ To build the package:
20
+
21
+ ```sh
22
+ pnpm run build
23
+ ```
24
+
25
+ To run tests:
26
+
27
+ ```sh
28
+ pnpm run test
29
+ ```
30
+
31
+ To run the linter:
32
+
33
+ ```sh
34
+ pnpm run lint
35
+ ```
36
+
37
+ To run the sandbox
38
+
39
+ ```sh
40
+ cd ../sandbox
41
+ pnpm run dev
42
+ ```
43
+
44
+ Installing directly for local development
45
+
46
+ ```sh
47
+ pnpm i ../path/to/this/packages/components
48
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@socotra/ec-react-utils",
3
- "version": "0.0.0-alpha.3",
3
+ "version": "2.0.0",
4
4
  "type": "module",
5
5
  "main": "./dist/index.umd.js",
6
6
  "module": "./dist/index.es.js",
@@ -22,8 +22,8 @@
22
22
  },
23
23
  "dependencies": {
24
24
  "@jsonforms/core": "^3.3.0",
25
- "@socotra/ec-react-schemas": "^0.0.0-alpha.3",
25
+ "@socotra/ec-react-schemas": "2.0.0",
26
26
  "ajv": "^8.14.0"
27
27
  },
28
- "gitHead": "8e7faaf5ff9a4f7593a3b68a6114e742aa52c443"
28
+ "gitHead": "5e96b14b598fbda3cefa31ed17ba298a4b4c2f90"
29
29
  }