@devory/core 0.0.1 → 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.
package/README.md ADDED
@@ -0,0 +1,41 @@
1
+ # @devory/core
2
+
3
+ Shared types, parsing utilities, and path configuration for [Devory](https://devory.ai).
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install @devory/core
9
+ ```
10
+
11
+ ## API
12
+
13
+ ### Task parsing
14
+
15
+ ```ts
16
+ import { parseFrontmatter } from '@devory/core'
17
+
18
+ const result = parseFrontmatter(fileContent)
19
+ // result.meta — typed TaskMeta fields
20
+ // result.body — markdown body after frontmatter
21
+ ```
22
+
23
+ ### Factory environment
24
+
25
+ ```ts
26
+ import { resolveFactoryEnvironment, factoryPaths } from '@devory/core'
27
+
28
+ const env = resolveFactoryEnvironment()
29
+ const paths = factoryPaths(env.root)
30
+ // paths.tasksDir, paths.runsDir, paths.artifactsDir, etc.
31
+ ```
32
+
33
+ ## Types
34
+
35
+ - `TaskMeta` — frontmatter fields for a Devory task file
36
+ - `FactoryEnvironment` — resolved root, mode, and source
37
+ - `FactoryPaths` — all well-known directories in a factory workspace
38
+
39
+ ## Requirements
40
+
41
+ - Node.js 18+