@mcoda/shared 0.1.6 → 0.1.8
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/CHANGELOG.md +1 -1
- package/README.md +19 -2
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -2,8 +2,25 @@
|
|
|
2
2
|
|
|
3
3
|
Shared utilities and schemas used across the mcoda workspace.
|
|
4
4
|
|
|
5
|
-
##
|
|
6
|
-
|
|
5
|
+
## Install
|
|
6
|
+
- Requires Node.js >= 20.
|
|
7
|
+
- Install: `npm i @mcoda/shared`
|
|
8
|
+
|
|
9
|
+
## What it provides
|
|
10
|
+
- PathHelper for resolving mcoda directories.
|
|
11
|
+
- CryptoHelper for local secret encryption.
|
|
12
|
+
- CommandMetadata helpers and OpenAPI types.
|
|
13
|
+
- QA profile types.
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
```ts
|
|
17
|
+
import { PathHelper } from "@mcoda/shared";
|
|
18
|
+
|
|
19
|
+
await PathHelper.ensureDir(PathHelper.getGlobalMcodaDir());
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Notes
|
|
23
|
+
- Intended for use by other mcoda packages; APIs may evolve.
|
|
7
24
|
|
|
8
25
|
## License
|
|
9
26
|
MIT - see `LICENSE`.
|